v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Reporting

List Report Runs

This API endpoint retrieves report execution history for a specific report ID. Each report run contains execution details including run ID, status, export data, and start/end timestamps. Obtain the required report ID from the List Reports API.

get/network-reporting/v1/reports/{report-id}/report-runs

Path parameters

report-idstring required

The unique identifier of the user report.

Query parameters

sortstring

Sort expression. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

If a direction indicator is omitted the default direction is ascending.

Supported fields are modifiedAt and status.

The field modifiedAt denotes last modified timestamp of the report run and status indicates report run current state - New, Running, Failed or Successful.

nextstring

Specifies the pagination cursor for the next page of resources. Minimum value is 1.

limitinteger

Maximum number of report runs to be returned. Allowed range is 1 to 100.

Response

List Report runs Response

countinteger required

The number of report runs

totalinteger

The total number of report runs.

nextstring required

Specifies the pagination cursor for the next page of resources. null if there are no further pages.

Example response

{
  "report": {
    "createdAt": "2023-02-14T12:23:00.000Z",
    "updatedAt": "2023-10-01T12:00:00Z"
  },
  "items": [
    {
      "createdAt": "2023-02-14T12:23:00.000Z",
      "updatedAt": "2023-10-01T12:00:00Z"
    }
  ]
}