Skip to Content
APIEndpointsPerception

Brand Alignment: perception

GET /v1/brands/:brand_id/alignment/perception

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

The brand attributes the setup tracks, such as “Affordable” or “Easy to use”, in one scan, as the Brand attributes and Sentiment by attribute sections of the Brand Alignment page show them: how often answers associate each attribute with the brand, and how they evaluate it.

Asky manages the monitoring questions. Responses include the figures and the exact quotes behind them without exposing generated question text.

Query parameters

ParameterTypeDescription
scan_iduuidFinished scan identifier 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).
attributestringOne attribute, by its exact label: its figures and its mentions.
sentimentstringOnly mentions with this sentiment: positive, mixed, negative or neutral. Works with or without attribute.
by_enginebooleanAlso each attribute per engine.
mentions_limitintegerMentions to return with attribute or sentiment, from 1 to 50. Defaults to 20.
mentions_offsetintegerMentions to skip. Follow has_more to read the next ones.

Response

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

FieldDescription
scan, previous_scanThe scan, and the finished scan before it (or null).
comparable_with_previousFalse when the setup or its evaluation changed between the two scans. Changes are then null.
answers_assessedAnswers assessed for attributes in this selection.
sentimentMentions per sentiment (positive, mixed, negative, neutral) across the attributes returned.
attributesMost associated first: label, mentioned_in (answers associating it with the brand), assessed, association (value in percent with its numerator and denominator), sentiment counts, from_scan_questions, from_tracked_prompts and change_since_previous (mentioned_in and association_points, or null). With by_engine, also by_engine.
mentionsWith attribute or sentiment: answer_id, engine, country, locale, stream, attribute, sentiment and the exact quote.
mentions_total, has_moreHow many mentions match, and whether more follow mentions_offset.

Read an answer in full with the answer endpoint. Trends across scans are the history endpoint. Scan identifiers come from the program endpoint.

Last updated on