Listing all traffic report subscriptions¶

Note

The query parameter language determines the language of the response. It is not a data filter and does not affect which subscriptions are returned.

Sends a GET request to the endpoint /report-subscriptions.

Description¶

The List-Subscriptions request allows the user to request a list of all traffic report subscriptions.

Requirements¶

Values of the request: none

Objects: none

Request¶

To request a list of all traffic report subscriptions, no additional information needs to be added to the path of the request.

The following optional query parameters are available to filter and sort the results:

Attributes	Description	Values
`search`	Filters the results by a search term matched against the subscription name.	`string`
`active`	Filters the results by the active status of the subscription.	`true` `false`
`domain`	Filters the results by a domain name associated with the subscription.	`string`
`sort`	The attribute by which to sort the results.	`string`
`direction`	The sort direction.	`asc` `desc`
`page`	The page number for paginated results. Minimum value: 1.	`integer`
`perPage`	The number of entries per page. Minimum value: 1.	`integer`

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

The object provides the following information:

Attributes	Description	Values
`id`	The ID of the subscription.	`string`
`name`	The name of the subscription.	`string`
`domains`	The domain names associated with the subscription.	`array[string]`
`vhosts`	The subdomain names associated with the subscription.	`array[string]`
`language`	The language of the traffic reports generated by this subscription.	`de` `en`
`active`	Shows whether the subscription is active.	`true` `false`
`comments`	A comment for the subscription.	`string`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "search": "string",
    "active": true,
    "domain": "string",
    "sort": "string",
    "direction": "asc",
    "page": 0,
    "perPage": 0,
    "id": "string",
    "name": "string",
    "domains": [],
    "vhosts": [],
    "language": "de",
    "comments": "string",
    "modified": "2026-01-01T00:00:00+00:00",
    "created": "2026-01-01T00:00:00+00:00"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
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.