Skip to Content
APIEndpointsOverview

Brand Alignment: overview

GET /v1/brands/:brand_id/alignment

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

Asky manages the monitoring questions. Responses include fact results and answer evidence without exposing generated question text.

Query parameters

ParameterTypeDescription
scan_iduuidFinished scan identifier from the program endpoint. Defaults to the latest finished scan.
include_positioningbooleanAlso return the positioning statement and attributes the scan compared against.

Response

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

FieldDescription
scanThe scan these figures describe: id, cutoff, state (finished or running) and published_at.
previous_scanThe finished scan before it, or null.
outcomesThe three cards at the top of the Brand Alignment page: aligned, contradicted and identity (the engine did not recognize the brand), each the share of assessed answers as value (percent, null when nothing was assessed) with its numerator and denominator. Identity is measured by Asky’s scan questions only.
headlineAlignment score, confirmation and recall rates, how often engines recognize the brand, and fact and answer counts.
engines, categoriesThe same figures per engine and per fact category.
changesWhat moved per fact since the previous scan, or null without one.
positioningWith include_positioning: the positioning statement and attributes the scan compared against. How the engines position the brand against them is the positioning endpoint.

Trends across scans are the history endpoint. Scan identifiers come from the program endpoint. Historical scans keep their original evidence. A setup edit applies to future scans.

Last updated on