Skip to navigation

Get an analysis

Requires analyses:read, or analyses:run for an an_… analysis created by the same key (so a run-only key can poll the Location it was given). For analyses created with POST /analyses (an_… ids) this is the poll endpoint: status is queued, running, ready, or failed; scope, content, and commentAnalysis are populated once ready. Non-terminal responses include Retry-After and meta.pollAfterMs.

For persisted campaign reports (kind: report) the payload includes the stored report. Comment bodies are never included; sample them at GET /analyses/{analysisId}/comments (comments.path).

Rate class analysis_read (60 / minute, 2,000 / day per key). Poll at meta.pollAfterMs; polling faster only spends this budget.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
X-Api-Keystring
API Key authentication via header

Path parameters

analysisIdstringRequired

Response headers

Retry-Afterinteger

Present while the analysis is still queued / running

Response

Analysis detail, including comments.path

dataobjectOptional

An analysis created with POST /analyses. scope, content, and commentAnalysis are null until status is ready. content is creator-side (what was posted); commentAnalysis is audience-side (how the matched comments landed). A sample of comments behind the analysis lives at comments.url (absolute) / comments.path; flat tables at export.url / export.path.

A kind: comparison analysis has sides (the definition) and comparison (the result) instead of scope / content / commentAnalysis.

metaobjectOptional

Errors

404
Not Found Error