Synup
Create a key
v1Resources/AEO/getList a website's prompt checks

List a website's prompt checks

Returns the website's prompt checks, newest first, without their answers: when each was captured and settled, its status, the set revision and engines it measured, and how many answers were usable. An archived report from before prompts were managed is listed with source legacy_report. Read-only: listing never starts a check.

get/api/v1/aeo/prompts/checks
aeo:read
Query parameters
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.
limitintegeroptional
How many checks to return, newest first: 1 to 100, default 24. Values outside that range are clamped.
Response
dataarray of objectoptional
idstringoptional
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.
promptSetRevisionintegeroptional
The set revision the check captured.
promptCountintegeroptional
How many prompts the check captured.
enginesarray of stringoptional
The AI engines selected for this check.
measuredintegeroptional
How many answers were usable.
expectedintegeroptional
How many answers were expected from the captured prompts and engines.
publicationstring (published | superseded)optional
published when the check's results became the website's report, superseded when a newer result had already taken its place, or null.
sourcestring (legacy_report)optional
legacy_report on an archived report from before prompts were managed; absent on a prompt check.
legacyEnginesarray of objectoptional
Archived legacy reports only: each engine's score and its measured and expected prompt counts as the report stored them. A value it didn't store is null, never zero.
enginestringoptional
scorenumberoptional
measuredPromptsintegeroptional
expectedPromptsintegeroptional
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/checks
Your API key
locationId *
limit
{}

Guides that use this resource