Responses

List responses of all widgets

Form responses of every widget of the site in one list, oldest first (ascending id); order=newest gives the latest first (descending id). Call it for the latest responses across the site's widgets, e.g. to summarize what visitors sent lately; widget_id narrows it to some widgets. Each item is the same as in list_widget_responses, its widget_id naming the widget and its fields read by that widget's form.

Responses of deleted widgets of the site are included, as by list_widget_responses. A widget_id of no widget of the site matches nothing.

A page holds up to limit responses; while next_cursor is set, pass it as cursor for the next page with the same order, widget_id, created_since and created_before. Both periods filter by the time a response was sent.

Completeness is as in list_widget_responses: a response awaiting double opt-in or an e-mail check appears later with its original id and send time, a deleted one disappears, and contact_id may be null on a fresh response.

get/v1/sites/{site_id}/responses

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required

Query parameters

widget_idinteger[]

Only responses of these widgets, ids from list_widgets; repeat for several. Omit for every widget of the site

created_sincestring date-time

Sent at or after this moment; without an offset, taken as UTC; a plain date means its start

created_beforestring date-time

Sent before this moment; without an offset, taken as UTC; a plain date means its start. A moment later than now is accepted and covers every response sent so far

cursorstring

next_cursor of the previous page, sent with the same order; omit for the first

limitinteger

Items per page

fieldsstring

Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field

order'oldest' | 'newest'

Order of a list. oldest: the oldest item first; newest: the newest item first, for the latest items without paging through the history.

Order of the items: oldest first (default) or newest first; asc and desc mean the same

Response

Successful Response

next_cursorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.