Synup
Create a key
v1Resources/AEO/getGet a tracked prompt's check history

Get a tracked prompt's check history

Returns, newest first, the checks that captured this prompt among the website's 100 most recent checks: the wording each one measured, its status and that wording's answers per engine. Only checks are listed — a wording that was saved but never checked does not appear — and earlier wordings stay listed after an edit or removal. Read-only. A prompt no check captured returns an empty list.

get/api/v1/aeo/prompts/{promptId}/history
aeo:read
Query parameters
promptIdstringrequired
The tracked prompt's id.
locationIdstringrequired
The website entity's location id. A website you can't see, or one that doesn't exist, is 404; a physical location is 422 entity_type_not_supported.
Response
dataobjectoptional
promptIdstringoptional
The tracked prompt's id.
checksarray of objectoptional
The checks that captured this prompt, newest first, from the website's 100 most recent checks.
collectionIdstringoptional
Unique identifier for the check.
capturedAtstringoptional
When the check captured the prompts it measures, as an ISO 8601 timestamp.
settledAtstringoptional
When the check finished, or null while it is still in progress.
statusstring (captured | running | complete | partial | failed | held)optional
captured, running, complete, partial (some answers missing), failed, or held (the outcome is unknown and needs reconciliation; neither complete nor failed). A failed or held check may have stopped before every expected answer was requested.
wordingVersionintegeroptional
The wording's version: 1 when created, one higher after every wording change. Send it back as expectedWordingVersion.
textstringoptional
The prompt's wording. In a check or history entry, the wording that check measured.
observationsarray of objectoptional
promptIdstringoptional
The tracked prompt's id.
wordingVersionintegeroptional
The wording's version: 1 when created, one higher after every wording change. Send it back as expectedWordingVersion.
promptTextstringoptional
The prompt's wording. In a check or history entry, the wording that check measured.
enginestringoptional
The AI engine that answered.
outcomestring (measured | unusable | failed)optional
measured (a usable answer), unusable (the engine answered, but the answer couldn't be judged) or failed (no answer). Only measured is a result; the others are never read as zero.
mentionedbooleanoptional
Whether the business was mentioned in the answer.
ranknumberoptional
The business's position among mentions, or null when it wasn't mentioned or ranked.
scorenumberoptional
Rank-derived score for this answer, 0-100, or null when there is none.
answerExcerptstringoptional
An excerpt of the engine's answer, or null when none was kept.
enginesarray of stringoptional
The AI engines selected for this check.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Follow the retry guidance for this operation.
get/api/v1/aeo/prompts/{promptId}/history
Your API key
promptId *
locationId *
{}

Guides that use this resource