GET Study Structure

get

http://ai-quality-service.default.svc.cluster.local:8080/insights/api/v1/studies/{studyId}/structure

Get a study's aggregated structure, ready to join directly to insights round data.
Nodes and answer ids are expressed in template ids, so they join to a round's answers.

By default returns the full aggregate across all published wave surveys.
Use the optional query parameters to narrow the view:

survey_ids: restrict to specific wave survey GUIDs
audience_ids: restrict to surveys whose template audience matches these UUIDs
node_ids: return only the specified survey nodes

survey_ids takes precedence over audience_ids when both are supplied.

Content resolution across waves/audiences:

Copy & media: from the template; with localized=true, from the latest selected
wave's localised content (requires exactly one audience, else 422).
Qualifying & randomization: taken from the latest selected wave (combined across its
audiences) — these can change between waves, so the current state is returned.
omittedFrom (on nodes/fields/subjects): the audience ids that card or option is
hidden from in the latest selected wave. Reflects the current survey state; call the
API per wave for historical per-wave visibility.
Each survey in surveys[] carries its publishedAt and waveIndex (0 = oldest,
stable across calls) so you can fetch the base structure, then filter by wave.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

studyId

string

required

The ID of the study

Query Params

survey_ids

array of strings

Restrict to these wave survey GUIDs. Returns the aggregate view across only these surveys.

survey_ids

audience_ids

array of uuids

Restrict to surveys whose audience matches these UUIDs.
Ignored when survey_ids is also supplied.

audience_ids

node_ids

array of strings

Return only the specified survey nodes. Pass the special value none to return
no nodes at all (useful to retrieve audiences and surveys metadata only).

node_ids

countries

array of strings

Restrict to audiences matching these ISO 2-letter country codes (e.g. "GB", "US").
Multiple values are OR-combined.

countries

languages

array of strings

Restrict to audiences matching these 3-letter language codes (e.g. "ENG", "SPA").
Multiple values are OR-combined.

languages

waveIndices

array of integers

Select waves by index, ordered by publish time (oldest = 0). Negative indices
count from the latest: -1 = latest, -2 = second latest, etc. Multiple values
select multiple waves. Returns 422 if any index is out of range.

waveIndices

localized

boolean

Return titles and labels in the language of the audience. Requires exactly one
audience to be present in the filtered result. Returns 422 if multiple audiences
are found.

Responses

200Survey structure

400Validation error response

401Authentication, authorization or access error response

403Authentication, authorization or access error response

404Domain or business error response

405Client error response (excluding business/domain errors)

415Client error response (excluding business/domain errors)

422Domain or business error response

500Server error response

501Server error response

503Server error response