v1Resources/AEO/getGet one prompt check
Get one prompt check
Returns one check with the exact wording it captured when it was admitted and every answer it recorded, read from the check itself rather than from today's prompts. An archived legacy report returns its per-keyword results in legacyResults and its per-engine scores in legacyEngines instead. Read-only. A check that doesn't belong to this website is 404.
get
aeo:read/api/v1/aeo/prompts/checks/{checkId}Query parameters
checkIdstringrequired
The check's id, from the checks list or a prompt's history.
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
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/{checkId}
Your API key
checkId *
locationId *
{}Guides that use this resource
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- What Is an AEO API?An AEO API measures how AI answer engines like ChatGPT, Gemini and Perplexity describe and recommend a business, and tracks that visibility over time.
- How to Build an AI Agent for Local SEOBuild an AI agent that audits and fixes listings, tracks local rankings, checks AI visibility and drafts review replies with Synup's MCP server or REST tools.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- Local SEO APIs: What Developers Actually NeedA practical checklist of what a local SEO API must cover, from listings and sync status to reviews, rank tracking and AI visibility, mapped to endpoints.
- How to Monitor Local SEO Across Multiple LocationsMonitor local SEO across hundreds of locations through rollup endpoints, with rank and AI visibility per location and the weakest surfaced first.
- How to Track AI and AEO Visibility ProgrammaticallyMeasure how ChatGPT, Gemini and Perplexity describe and recommend a business through an API, enqueue reports, poll for results and roll up a portfolio.