Skip to Content

Brand Alignment: history

GET /v1/brands/:brand_id/alignment/history

Access is limited to the brands permitted by your credential. Requires read:alignment. Workspace API keys and signed-in MCP sessions are supported.

Trends across finished scans, oldest first, as the “Changes over time” chart on the Brand Alignment page shows them: up to 26 scans ending at scan_id.

Asky manages the monitoring questions. Responses include results without exposing generated question text.

Query parameters

ParameterTypeDescription
scan_iduuidThe last scan to include, from the program endpoint. Defaults to the latest finished scan.
modelsstring (repeatable)Engine identifiers. Repeat this parameter to select multiple engines.
marketsstring (repeatable)Country codes (DE) or one country and language (DE:de-DE). Repeat this parameter to select multiple markets.
streamstringdedicated for answers to Asky’s scan questions, ordinary for tracked-prompt answers that mention the brand, or all (the default).
attributesstring (repeatable)Attributes to trend, by exact label, up to 10. Defaults to the four most associated in the last scan. Repeat this parameter for each attribute.
sentiment_attributestringThe sentiment of this attribute only. Defaults to every tracked attribute.
sincedateOnly scans on or after this date (YYYY-MM-DD).
by_enginebooleanAlso the outcome shares per engine.

Response

The standard API envelope places the result in data, with request metadata in meta.

FieldDescription
attributesThe attributes trended.
attributes_availableEvery attribute label measured in these scans.
scansOldest first. Scans with nothing measured in the selection are left out.
scans[].outcomesaligned, contradicted and identity as shares of assessed answers (value in percent with its numerator and denominator), the cards at the top of the page. Null when no fact was measured.
scans[].outcomes_changeThe change in percentage points since the scan before, per outcome. Null for the first scan and wherever the setup changed.
scans[].sentimentpositive, mixed, negative and neutral as shares of evaluated attribute mentions.
scans[].attributesEach trended attribute’s association: the share of assessed answers associating it with the brand.
scans[].setup_changedalignment and perception: true where the monitoring setup differs from the scan before. The page breaks its line there, so a difference across it is not a trend.
scans[].by_engineWith by_engine: the outcome shares per engine.

One scan in detail is the overview and the perception endpoint. Scan identifiers come from the program endpoint.

Last updated on