API v1

List reports

List the reports this API key can read, newest first. Use a returned id with GET /v1/reports/:id/intelligence. status is completed for a finished competitive analysis, no_competitors for a finished report that analysed no competitor (a profile of the product alone, which names no threat), and unavailable for a report that cannot be read. competitors_analyzed is how many competitors the report analysed (null when not recorded).

get/api/v1/reports

Request

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

Query parameters

project_idstring uuid

Only this project

limitinteger
offsetinteger

Response

Success. Reports in the data envelope, with pagination.

dataobject[] required

Changes

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