Getting a traffic report subscription¶

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

Description¶

The Get-Subscription request allows the user to request a report subscription for a specified ID.

Requirements¶

Values of the request: Subscription-ID {id}d}

Objects: none

Request¶

To request a report subscription, the Subscription-ID {id} needs to be added to the path of the request.

As a result, the user gets a subscription object 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:

{
  "id": "string",
  "name": "string",
  "domains": [],
  "vhosts": [],
  "language": "de",
  "active": true,
  "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.