Skip to main content
GET
Get survey trends

Authorizations

x-api-key
string
header
required

API key for authentication. Generate keys in the Doozy dashboard.

Path Parameters

surveyId
string
required

The unique identifier of the survey

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"survey_abc123"

Query Parameters

track_id
string

Only include deliveries from this track

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
schedule_id
string

Only include deliveries created by this schedule

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
group_ids
string[]

Account group IDs. Matches participants in any selected group. A comma-separated query value is also accepted.

Required array length: 1 - 50 elements
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:
work_location_ids
string[]

Work-location IDs. Matches participants at any selected location. A comma-separated query value is also accepted.

Required array length: 1 - 50 elements
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:
manager_ids
string[]

Manager-of-record user IDs. Matches direct reports of any selected manager. A comma-separated query value is also accepted.

Required array length: 1 - 50 elements
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:
audience_groups
string

JSON-encoded audience groups. Groups match with OR; populated fields inside a group match with AND; values inside each field match with OR. Takes precedence over the flat demographic parameters.

Maximum string length: 20000
Example:

"[{\"group_ids\":[\"group_engineering\"],\"country_codes\":[\"GB\"]},{\"group_ids\":[\"group_sales\"],\"cities\":[\"Berlin\"]}]"

Response

Survey trends with per-instance question analytics

object
enum<string>
required

Object type identifier

Available options:
survey_trends
Example:

"survey_trends"

id
string
required

Survey ID

Example:

"survey_abc123"

instances
object[]
required

Instances in chronological order

questions
object[]
required

Per-question trend data across instances