SurfacedBySurfacedBy Docs
DocumentationAPIReference

Analytics

Read comprehensive scan results, cited sources, trend deltas, and scored opportunities for a tracked domain.

Ask an AI:Open in ChatGPTOpen in Claude

Analytics endpoints surface everything the dashboard renders on a domain's main page, but in machine-readable form. Use /analytics as the single entry point for the current-scan snapshot; use /citations, /diff, and /opportunities when you want to hydrate a specific widget without paying for the full payload.

All four endpoints default to the domain's most recent completed scan. Pass scan_id on /analytics to pin an answer to a historical scan. These endpoints are read-only and available on Professional and Business.

GET
/domains/{domain_id}/analytics
/domains/{domain_id}/analytics

Path Parameters

domain_id
Required
Domain Id

Query Parameters

scan_idScan Id

Override the latest scan; useful for time-machine views

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/analytics?scan_id=string" \
  -H "X-API-Key: string"

Successful Response

null

GET
/domains/{domain_id}/citations
/domains/{domain_id}/citations

Path Parameters

domain_id
Required
Domain Id

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/citations" \
  -H "X-API-Key: string"

Successful Response

null

GET
/domains/{domain_id}/diff
/domains/{domain_id}/diff

Path Parameters

domain_id
Required
Domain Id

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/diff" \
  -H "X-API-Key: string"

Successful Response

null

GET
/domains/{domain_id}/opportunities
/domains/{domain_id}/opportunities

Path Parameters

domain_id
Required
Domain Id

Query Parameters

cursorCursor

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/opportunities?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null