ListDataTrafficReports

List available data traffic reports.

Path Parameters

• domainId string required

  Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

  Domain the resource belongs to. Used to determine which users have access to the resource.

Query Parameters

• startDate date

  Start date, written in YYYY-MM-DD or YYYY-MM format.

• endDate date

  End date, written in YYYY-MM-DD or YYYY-MM format.

Responses

• 200
• 400
• 401
• 500

---

List of data traffic reports.

application/json

• Schema
• Example (from schema)

---

Schema array

period string

The period the report covers.

resource string

Path where the report can be downloaded.

fileFormat string

The file format of the report.

size number

Size of the report in bytes.

[
  {
    "period": true,
    "resource": true,
    "fileFormat": "gzip",
    "size": 1024
  }
]

Bad request. The server cannot process the request.

application/json

• Schema
• Example (from schema)

---

Schema

• description string

  Human readable description of the error

• errorCode string

  String constant describing the error.

• timestamp date-time

  ISO 8601 timestamp specifying when error occurred.

{
  "description": true,
  "errorCode": true,
  "timestamp": "2024-10-17"
}

Invalid or missing ID Token (JWT).

Internal server error.

application/json

• Schema
• Example (from schema)

---

Schema

• description string

  Human readable description of the error

• errorCode string

  String constant describing the error.

• timestamp date-time

  ISO 8601 timestamp specifying when error occurred.

{
  "description": true,
  "errorCode": true,
  "timestamp": "2024-10-17"
}

Loading...