Retrieve Responses

get https://api.sprig.com/v1/responses

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

Query Params

start

integer

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

end

integer

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

cursor

string

A Base64 encoded string representing an opaque cursor position

limit

integer

1 to 1000

Specific number of results to return

sid

integer

An integer id for a specific Survey

with_snapshots

boolean

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_urls

boolean

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

with_meta

boolean

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

with_custom_metadata

boolean

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

with_deleted_responses

boolean

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

Headers

Authorization

string

required

Bearer 8abaf7cb-fake-fake-fake-c608317728bd

Responses

403

You may have an invalid or missing API key and you should check your authorization header. There is no message with this status code.

404

Not Found

429

Your application has made too many requests in too short a time.

500

Something went wrong on Sprig's side. These are very rare :)

200OK

400Bad Request