Survey
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all surveys
Required API key scopes
survey:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- searchstring
A search term.
Response
Status 200
Create surveys
Required API key scopes
survey:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 201
Retrieve surveys
Required API key scopes
survey:read
Path parameters
- idstring
A UUID string identifying this survey.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Update surveys
Required API key scopes
survey:write
Path parameters
- idstring
A UUID string identifying this survey.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Delete surveys
Required API key scopes
survey:write
Path parameters
- idstring
A UUID string identifying this survey.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 204 No response body
Retrieve surveys activity retrieve
Required API key scopes
activity_log:read
Path parameters
- idstring
A UUID string identifying this survey.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve surveys stats retrieve
Get survey response statistics for a specific survey.
Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)
Returns: Survey statistics including event counts, unique respondents, and conversion rates
Required API key scopes
survey:read
Path parameters
- idstring
A UUID string identifying this survey.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create surveys summarize responses
Required API key scopes
survey:read
Path parameters
- idstring
A UUID string identifying this survey.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve surveys activity
Required API key scopes
activity_log:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve surveys responses count
Required API key scopes
survey:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve surveys stats
Get aggregated response statistics across all surveys.
Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)
Returns: Aggregated statistics across all surveys including total counts and rates
Required API key scopes
survey:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.