API Reference

GET Study Rounds

get
http://insights-svc.default.svc.cluster.local:8080/insights/api/v1/study//rounds

Returns all of the rounds associated with a particular study

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Path Params
string
required

The unique identifier of the study.

Query Params
surveyIds
array of strings

A comma-separated list of survey IDs to filter the results.

surveyIds
cardIds
array of uuids

A comma-separated list of card IDs to filter responses.

cardIds
roundIds
array of uuids

A comma-separated list of round IDs to filter results.

roundIds
string

An EFL (Extended Filter Language) query string to filter rounds. Example: demographics.age > 18 AND demographics.gender = 'male'. Another example: audience.country = 'US' AND waveTimestamp > 1704067200000

outcomes
array of strings

A list of round outcomes to include. Defaults to COMPLETED, APPROVED, SCREENED_OUT.

outcomes
Allowed:
demographics_for_outcomes
array of strings

A list of outcome values for which demographics data should be included. If omitted, demographics data is included only for COMPLETED and APPROVED rounds. If specific outcomes are provided, demographics data is included only for rounds with those outcomes. If false is provided, demographics data is not included for any rounds.

demographics_for_outcomes
Allowed:
progress
array of strings

A list of round progress values to include. Defaults to FINISHED.

progress
Allowed:
boolean

Include startedAt timestamps on rounds, and respondedAt timestamps on cards when true.

Responses

Updated about 23 hours ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 23 hours ago