v1

latestOpenAPI 3.1.02026-07-226130.1 KB
V1

Retrieve Responses

Use this endpoint to retrieve responses from your studies. This endpoint allows you to retrieve up to 1000 responses at a time.

get/v1/responses

Query parameters

startinteger

The earliest creation data for a generated theme to return, represented as milliseconds from epoch time

endinteger

The latest creation date for a generated theme to return, represented as milleseconds from epoch time

cursorstring

A Base64 encoded string representing an opaque cursor position

limitinteger

Specific number of results to return

sidinteger

An integer id for a specific Survey

with_snapshotsboolean

true/false(default). If true, the API will return visitorSnapshots, which contains all events, attributes, triggeringEvent, and eventProperties set for the visitor at the time of survey delivery.

with_urlsboolean

true/false (default). If true, the API will return the page URL from which the survey was taken.

with_metaboolean

true/false (default). If true, the API will return the metadata JSON blob containing details available from the client.

with_custom_metadataboolean

true/false (default). If true, the API will return any custom metadata associated with the response (applicable to link platform surveys only).

with_deleted_responsesboolean

true/false (default). If true, the API will return the responses that have been previously deleted.

Headers

Authorizationstring required

Bearer YOUR_API_KEY

Response

OK

cursorstring
All 6 operations