API docs v1

API reference / 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}.

15 endpoints

  1. GET /v1/reports List reports
  2. POST /v1/reports Create a report
  3. GET /v1/reports/{report_id} Retrieve a report
  4. PATCH /v1/reports/{report_id} Update a report
  5. DELETE /v1/reports/{report_id} Delete a report
  6. GET /v1/reports/{report_id}/ai-analysis Get AI analysis
  7. POST /v1/reports/{report_id}/ai-suggestions Generate AI suggestion
  8. GET /v1/reports/{report_id}/competitors List a report's competitors
  9. GET /v1/reports/{report_id}/prompts List report prompts
  10. POST /v1/reports/{report_id}/prompts Add report prompts
  11. DELETE /v1/reports/{report_id}/prompts Clear report prompts
  12. PATCH /v1/reports/{report_id}/prompts/{prompt_id} Update a report prompt
  13. DELETE /v1/reports/{report_id}/prompts/{prompt_id} Delete a report prompt
  14. POST /v1/reports/{report_id}/runs Run analysis
  15. GET /v1/reports/{report_id}/summary Get report summary