Listing all months with traffic report data¶

Note

This endpoint is only available to organisations with traffic reports enabled and requires admin-level access.

Note

SOC accounts cannot call this endpoint with a personal access token. There is no organisation-related token equivalent for it. Instead, use the access options via the web application (session authentication).

Sends a GET request to the endpoint /traffic-report-groups.

Description¶

The List-Traffic-Report-Groups request returns a list of all months for which traffic report data is available for the active organisation.

Requirements¶

Values of the request: none

Objects: none

Request¶

To request a list of all months with traffic report data, no additional information is required in the path of the request.

As a result, the user gets one or more objects with the requested information.

The object provides the following information:

Attributes	Description	Values
`id`	The month identifier in the format `YYYY-MM`.	`string`

Example¶

Example response:

{
  "data": [
    {
      "id": "2026-04"
    }
  ]
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.