Skip to main content
POST
Query Responses

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json

Request body for querying responses

website_id
string<uuid>
required

The ID of the website to query responses for

Example:

"123e4567-e89b-12d3-a456-426614174000"

filters
object
required

Filters for querying responses and metrics. Pass location filters in the JSON body as filters.location_ids.

page_num
integer
default:0

Page number for pagination (0-indexed)

Required range: x >= 0
Example:

0

page_size
integer
default:40

Number of responses per page

Required range: 1 <= x <= 100
Example:

40

Response

Successful response with list of responses

responses
object[]
required