AIairtm
Reports

List Reports

List existing reports

get/reports

Request

Query parameters

beforestring

Gets results before the specified cursor.

afterstring

Gets results after the specified cursor.

type'PDF' | 'CSV' | 'XLSX' required

Type of activity report

Example:CSV

The type of report to filter by

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

The current status of the report

  • PENDING: The report is pending generation.
  • IN_PROGRESS: The report is currently being generated.
  • COMPLETED: The report has been generated and is ready for download.
  • FAILED: The report generation failed.

The status to filter by

perPageinteger

The maximum number of items to fetch.

Response

Ok

startCursorstring

The cursor for the first item in the current page.

endCursorstring

The cursor for the last item in the current page.

Example response

{
  "items": [
    {
      "type": "CSV"
    }
  ]
}

Changes

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