API v1

Report status

Get report status and data. Returns the report data when generation is complete. Poll this until data.status is completed, no_competitors or no_rivals (the run stopped before any research because none of its competitors could be counted as a rival; message names each one and why, and no credits were used); a report still in the human spot-check queue (PRD-305) reports as processing. Both are finished and carry report_data: no_competitors is a report that analysed no competitor (a profile of the product alone, which names no threat), and competitors_analyzed is how many competitors the report analysed.

get/api/v1/reports/{id}

Request

  • Base URL: https://api.rivalize.ai
  • URL: https://api.rivalize.ai/api/v1/reports/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Success. The resource is returned in the data envelope.

dataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.