List all analyses
Retrieves all past brand analyses for your authenticated account, ordered by most recent first.Endpoint
Request headers
Your API token in the format
Bearer YOUR_TOKEN.Response
Array of analysis summary objects.
Code examples
Example response
Get a single analysis
Retrieves the full analysis result for a specific analysis ID, including all visibility metrics, competitor data, platform breakdown, alerts, sources, and prompt analytics.Endpoint
Path parameters
The unique identifier of the analysis to retrieve. Obtain this from the list analyses endpoint or from a previous
POST /analyze result.Request headers
Your API token in the format
Bearer YOUR_TOKEN.Response
The response contains the full analysis result object. The structure matches thedata payload emitted in the final result SSE event from the POST /analyze endpoint.
Unique analysis identifier.
The brand name analyzed.
The brand URL analyzed, if provided.
ISO 8601 timestamp of when the analysis was created.
High-level mention and score summary.
Visibility metrics broken down by platform and time.
Competitor ranking data.
Auto-generated alerts from this analysis run.
Source attribution mapping AI citations to specific pages.
Per-prompt analytics.
true if this analysis was interrupted before it completed. Partial results may be present.Code examples
Example response
Error responses
| Status | Meaning |
|---|---|
401 | Missing or invalid Authorization header. |
404 | No analysis with the given ID exists, or it belongs to a different account. |
Delete an analysis
Permanently deletes an analysis from your account. This action cannot be undone.Endpoint
Path parameters
The unique identifier of the analysis to delete.
Request headers
Your API token in the format
Bearer YOUR_TOKEN.Response
true when the analysis was successfully deleted.The ID of the deleted analysis.
Code examples
Example response
Error responses
| Status | Meaning |
|---|---|
401 | Missing or invalid Authorization header. |
404 | No analysis with the given ID exists, or it belongs to a different account. |