GEgetsitecontrol
Responses

Get a response

One form response by id, with the same fields as in list_widget_responses. Call it when you hold a response id, e.g. from a response.created event. A response awaiting double opt-in or an e-mail check is not found until it is confirmed.

get/v1/sites/{site_id}/responses/{response_id}

Request

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

Path parameters

site_idinteger required
response_idinteger required

Response id from list_responses or list_widget_responses, or data.response.id of a response.created event subscription payload

Response

Successful Response

idinteger required
numberstring nullable

Response number, when the widget numbers its responses

widget_idinteger required
created_atstring date-time required

When the response was sent

contact_idinteger nullable

Set asynchronously; may be null on a fresh response

fieldsobject required

Answers by field name, in the order of the widget's current form. Options removed from the form since the response are left out.

paramsobject required

Visitor parameters as set on the site: arbitrary JSON that may hold personal data

page_urlstring nullable

Page the response was sent from, with its query string, which may hold e-mails or tokens

queryobject required

Query parameters of page_url, the last value of a repeated key; may hold e-mails or tokens

referrerstring nullable

Previous page of the visit on the site, not the external source; with its query string

sourcestring nullable

Page the visit came from, as the browser reported it on the visit's first page: usually another site, with its query string; null for a direct visit

warningsstring[] required

Empty unless the response could not be read; wording is not stable, do not parse

Changes

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