API docs v1

Resource

Reports

Create, list, retrieve and re-run AI visibility reports. Report creation is asynchronous and returns a job_id you can poll on GET /v1/jobs/{id}.

Operations

Method Endpoint Summary
GET /v1/reports List reports
POST /v1/reports Create a report
GET /v1/reports/{report_id} Retrieve a report
PATCH /v1/reports/{report_id} Update a report
DELETE /v1/reports/{report_id} Delete a report
GET /v1/reports/{report_id}/ai-analysis Get AI analysis
POST /v1/reports/{report_id}/prompts Add prompts
DELETE /v1/reports/{report_id}/prompts Clear prompts
PATCH /v1/reports/{report_id}/prompts/{prompt_id} Update a prompt
DELETE /v1/reports/{report_id}/prompts/{prompt_id} Delete a prompt
POST /v1/reports/{report_id}/runs Run analysis