List responses of one widget
Form responses of one widget, oldest first (ascending id); order=newest gives the latest first (descending id). Each holds the field values a visitor sent, the contact (contact_id), the page, visitor parameters, geo, UTM tags and device. Call it to read what visitors sent through a widget; one response by id is get_response. For the latest responses across all the site's widgets in one call, use list_responses.
For exact response totals and counts by form option, use get_widget_responses_summary instead of counting the returned records.
Responses of a deleted widget of the site are still returned by its id, although the widget itself is no longer listed by list_widgets or found by get_widget.
A page holds up to limit responses; while next_cursor is set, pass it as cursor for the next page with the same order; with order=newest, also with the same created_since and created_before. Both filter by the time a response was sent. To keep a copy in sync, follow next_cursor instead.
Neither the cursor nor created_since guarantees completeness. The send time is set when a response is received and the id when it is stored, so the two orders agree only approximately. A response awaiting double opt-in or an e-mail check appears later with its original id and send time. A deleted response disappears without a trace. When completeness matters, re-read a window with a margin of time and merge by id.
While a response is being completed it may briefly drop out of the list and return 404 from get_response; retry the request.
contact_id is set asynchronously and may be null on a fresh response.
Request
- Base URLhttps://api.getsitecontrol.com
- AuthHTTP bearer
Path parameters
Widget id from list_widgets
Query parameters
Sent at or after this moment; without an offset, taken as UTC; a plain date means its start
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
next_cursor of the previous page, sent with the same order; omit for the first
Items per page
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 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
Changes
No recorded changes to this operation across all 1 revision of this API.