Get report options
GET https://{{host}}/reporting-api/v2/reports/:productFamily/:reportingArea/:report
Returns available options to generate the report.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"defaults":{"defaultDimensions":["hostname","responseCode"],"defaultMetrics":["edgeHitsSum","edgeBytesSum"],"defaultSortBys":[{"name":"hostname","sortOrder":"ASCENDING"},{"name":"edgeHitsSum","sortOrder":"DESCENDING"}],"defaultTimeRange":{"end":"now - 9min 1sec","start":"now - 19min"}},"dimensions":[{"authorizable":false,"filterType":"TEXT","filterable":false,"mandatory":false,"name":"time5minutes","type":"TIMESTAMP_SEC"},{"authorizable":false,"filterType":"TEXT","filterable":false,"mandatory":false,"name":"time1hour","type":"TIMESTAMP_SEC"},{"authorizable":false,"filterType":"TEXT","filterable":false,"mandatory":false,"name":"time1day","type":"TIMESTAMP_SEC"},{"authorizable":true,"filterType":"TEXT","filterable":true,"mandatory":false,"name":"cpcode","type":"LONG"},{"authorizable":false,"filterType":"TEXT","filterable":true,"mandatory":false,"name":"hostname","type":"STRING"},{"authorizable":false,"filterType":"TEXT","filterable":true,"mandatory":false,"name":"responseCode","type":"LONG"},{"authorizable":false,"filterEnumValues":["0xx","1xx","2xx","3xx","4xx","5xx","6xx"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"responseClass","type":"STRING"},{"authorizable":false,"filterEnumValues":["error","success"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"responseStatus","type":"STRING"},{"authorizable":false,"filterEnumValues":["get_head","put_post"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"httpMethod","type":"STRING"},{"authorizable":false,"filterEnumValues":["non_secure","secure"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"deliveryType","type":"STRING"},{"authorizable":false,"filterEnumValues":["cacheable","non_cacheable"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"cacheability","type":"STRING"},{"authorizable":false,"filterEnumValues":["ipv4","ipv6"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"ipVersion","type":"STRING"},{"authorizable":false,"filterEnumValues":["http1.1","https1.1","http2","http3"],"filterType":"ENUM","filterable":true,"mandatory":false,"name":"httpProtocol","type":"STRING"},{"authorizable":false,"filterType":"TEXT","filterable":true,"mandatory":false,"name":"arlId","type":"LONG"}],"limits":{"dataPointsLimit":50000,"maxDateRangeInDays":92,"maxDimensions":4,"maxRetentionInDays":92,"textFilterMaxLength":100},"links":[{"allow":["GET"],"describedBy":"/reporting-api/v2/reports/schema","href":"/reporting-api/v2/reports/delivery/traffic/current","rel":"self"},{"allow":["POST"],"href":"/reporting-api/v2/reports/delivery/traffic/current/data","rel":"data"}],"metrics":[{"filterable":true,"mandatory":false,"name":"edgeBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"edgeHitsSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"edgeResponseBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"edgeRequestBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"originBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"originHitsSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"originResponseBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"originRequestBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"midgressBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"midgressHitsSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"midgressResponseBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"midgressRequestBytesSum","type":"LONG"},{"filterable":true,"mandatory":false,"name":"offloadedHitsPercentage","type":"DOUBLE"},{"filterable":true,"mandatory":false,"name":"offloadedBytesPercentage","type":"DOUBLE"},{"filterable":true,"mandatory":false,"name":"offloadedRequestBytesPercentage","type":"DOUBLE"},{"filterable":true,"mandatory":false,"name":"offloadedResponseBytesPercentage","type":"DOUBLE"}],"name":"CDN traffic report data","status":"PUBLISHED"}