The following shows how to generate the sxlmapping-by-time
report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.
Report definition
The data for DNS requests of any type that were made to process sessions associated with IPA traffic.
This report allows you to configure the aggregation interval for each data record. Available interval
values are: MONTH
, WEEK
, DAY
, HOUR
, FIVE_MINUTES
.
Business object: cpcode
Data available for: 92 days
Required products: Session Accelerator
Available metrics
Metric | Description |
---|---|
Data metrics | |
dnsRequests | The number of DNS requests of any type over time that were made to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served. |
geoMappedToOriginRequests | The number of DNS requests over time that are serviced by the Akamai mapper network and directed to retrieve content from an origin server. |
mappedToAkamaiRequests | The number of DNS requests over time that directed content to be retrieved from Akamai servers. |
mappedToOriginRequests | The number of DNS requests over time are mapped to retrieve content from an origin server. |
Summary metrics | |
dnsRequestsLatest | The most recent number of DNS requests of any type that were made as a function of time to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served. |
dnsRequestsMax | The highest number of DNS requests of any type that were made as a function of time to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served. |
dnsRequestsTotal | The total number of DNS requests of any type that were made as a function of time to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served. |
geoMappedToOriginRequestsLatest | The most recent number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server. |
geoMappedToOriginRequestsMax | The highest number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server. |
geoMappedToOriginRequestsTotal | The total number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server. |
mappedToAkamaiRequestsLatest | The most recent number of DNS requests that directed content to be retrieved from Akamai servers. |
mappedToAkamaiRequestsMax | The highest number of DNS requests that directed content to be retrieved from Akamai servers. |
mappedToAkamaiRequestsTotal | The total number of DNS requests that directed content to be retrieved from Akamai servers. |
mappedToOriginRequestsLatest | The most recent number of DNS requests are mapped to retrieve content from an origin server. |
mappedToOriginRequestsMax | The highest number of DNS requests are mapped to retrieve content from an origin server. |
mappedToOriginRequestsTotal | The total number of DNS requests are mapped to retrieve content from an origin server. |
Available filters
Filter | Type | Description |
---|---|---|
Optional filters | ||
slot | Integer | A unique configuration for a hostname. |
POST request
POST /reporting-api/v1/reports/sxlmapping-by-time/versions/1/report-data{?start,āend,āinterval}
Sample: /reporting-api/v1/reports/sxlmapping-by-time/versions/1/report-data?startā=2020-06-26T13%3A40%3A00Zā&endā=2020-06-26T14%3A00%3A00Zā&intervalā=FIVE_MINUTES
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2020-06-26T13:40:00Z | Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value's timestamp. |
end | String | 2020-06-26T14:00:00Z | Specifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp. |
interval | Enumeration | FIVE_MINUTES | The duration of each data record. Available values: MONTH , WEEK , DAY , HOUR , FIVE_MINUTES . |
JSON request members
Member | Type | Description |
---|---|---|
objectIds | Array | Specifies the set of cpcode values you want to report on. |
objectIds | Enumeration | As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required. |
metrics | Array | The set of desired metrics. If omitted, the report includes all available metrics. |
filters | Map of arrays | Specifies a set of custom filters, with each filter's name keying an array with each filter's set of values. |
Request body:
{
"objectIds": [
"55232",
"23433",
"32433"
],
"metrics": [
"dnsRequests",
"dnsRequestsLatest",
"dnsRequestsMax",
"dnsRequestsTotal",
"geoMappedToOriginRequests",
"geoMappedToOriginRequestsLatest",
"geoMappedToOriginRequestsMax",
"geoMappedToOriginRequestsTotal",
"mappedToAkamaiRequests",
"mappedToAkamaiRequestsLatest",
"mappedToAkamaiRequestsMax",
"mappedToAkamaiRequestsTotal",
"mappedToOriginRequests",
"mappedToOriginRequestsLatest",
"mappedToOriginRequestsMax",
"mappedToOriginRequestsTotal"
],
"filters": {
"slot": [
"11838",
"8927"
]
}
}
GET request
GET /reporting-api/v1/reports/sxlmapping-by-time/versions/1/report-data{?start,āend,āinterval,āobjectIds,āallObjectIds,āmetrics,āfilters}
Sample: /reporting-api/v1/reports/sxlmapping-by-time/versions/1/report-data?startā=2020-06-26T13%3A40%3A00Zā&endā=2020-06-26T14%3A00%3A00Zā&intervalā=FIVE_MINUTESā&objectIdsā=55232,ā23433,ā32433ā&metricsā=dnsRequests%2CdnsRequestsLatestā&filtersā=slot%3D140%2Cslot%3D8927
Query parameters
Parameter | Type | Sample | Description |
---|---|---|---|
Required | |||
start | String | 2022-06-23T13:55:00Z | Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start valueās timestamp. |
end | String | 2022-06-23T14:15:00Z | Specifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end valueās timestamp. |
interval | Enumeration | FIVE_MINUTES | The duration of each data record. Available values: MONTH , WEEK , DAY , HOUR , FIVE_MINUTES . |
Optional | |||
allObjectIds | Boolean | true | As an alternative to objectIds , enabling this generates a report that includes all IDs available for the cpcode objectType. This parameter is ignored if the request also specifies a set of objectIds. |
objectIds | String | 55232,ā23433,ā32433 | As an alternative to allObjectIds , specifies the set of unique IDs for the cpcode objectType you want to report on, formatted as a comma-delimited list. |
metrics | String | dnsRequests,ādnsRequestsLatest | Specifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request. |
filters | String | slot=ā140,āslot=ā8927 | Specifies criteria to filter the report's data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (= ) character, and separate various name/value pairs with commas (, ). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request. |
JSON response
Status 200 application/json
Response body:
{
"metadata": {
"name": "sxlmapping-by-time",
"version": "1",
"outputType": "FLAT",
"groupBy": [
"startdatetime"
],
"interval": "FIVE_MINUTES",
"start": "2020-06-26T13:40:00Z",
"end": "2020-06-26T14:00:00Z",
"availableDataEnds": null,
"suggestedRetryTime": null,
"rowCount": 4,
"filters": [
{
"name": "slot",
"values": [
"11838",
"140"
]
}
],
"columns": [
{
"name": "groupBy",
"label": "startdatetime"
},
{
"name": "dnsRequests",
"label": "DNS Requests"
},
{
"name": "geoMappedToOriginRequests",
"label": "Geo Mapped to Origin Requests"
},
{
"name": "mappedToAkamaiRequests",
"label": "Mapped to Akamai Requests"
},
{
"name": "mappedToOriginRequests",
"label": "Mapped to Origin Requests"
}
],
"objectType": "cpcode",
"objectIds": [
"55232",
"23433",
"32433"
]
},
"data": [
{
"startdatetime": "2020-06-26T13:40:00Z",
"dnsRequests": "1531",
"geoMappedToOriginRequests": "1578",
"mappedToAkamaiRequests": "2880",
"mappedToOriginRequests": "855"
},
{
"startdatetime": "2020-06-26T13:45:00Z",
"dnsRequests": "2396",
"geoMappedToOriginRequests": "4950",
"mappedToAkamaiRequests": "3827",
"mappedToOriginRequests": "2210"
},
{
"startdatetime": "2020-06-26T13:50:00Z",
"dnsRequests": "3883",
"geoMappedToOriginRequests": "4241",
"mappedToAkamaiRequests": "1624",
"mappedToOriginRequests": "882"
},
{
"startdatetime": "2020-06-26T13:55:00Z",
"dnsRequests": "3166",
"geoMappedToOriginRequests": "2259",
"mappedToAkamaiRequests": "382",
"mappedToOriginRequests": "1502"
}
],
"summaryStatistics": {
"dnsRequestsLatest": {
"value": "1943",
"details": {}
},
"dnsRequestsMax": {
"value": "1933",
"details": {}
},
"dnsRequestsTotal": {
"value": "445",
"details": {}
},
"geoMappedToOriginRequestsLatest": {
"value": "1864",
"details": {}
},
"geoMappedToOriginRequestsMax": {
"value": "4262",
"details": {}
},
"geoMappedToOriginRequestsTotal": {
"value": "4079",
"details": {}
},
"mappedToAkamaiRequestsLatest": {
"value": "2527",
"details": {}
},
"mappedToAkamaiRequestsMax": {
"value": "4903",
"details": {}
},
"mappedToAkamaiRequestsTotal": {
"value": "1607",
"details": {}
},
"mappedToOriginRequestsLatest": {
"value": "1279",
"details": {}
},
"mappedToOriginRequestsMax": {
"value": "2089",
"details": {}
},
"mappedToOriginRequestsTotal": {
"value": "206",
"details": {}
}
}
}
CSV response
Status 200 text/csv
Response Body:
#METADATA_START
name,āsxlmapping-by-time
version,ā1
source,āsxlmapping-by-time/versions/1
groupBy,āstartdatetime
start,ā2020-06-26T13:40:00Z
end,ā2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,ā4
objectType,ācpcode
objectIds,ā55232,ā23433,ā32433
slot,ā11838,ā140
#METADATA_END
#SUMMARYSTATISTICS_START
dnsRequestsLatest,ā1943
dnsRequestsMax,ā1933
dnsRequestsTotal,ā445
geoMappedToOriginRequestsLatest,ā1864
geoMappedToOriginRequestsMax,ā4262
geoMappedToOriginRequestsTotal,ā4079
mappedToAkamaiRequestsLatest,ā2527
mappedToAkamaiRequestsMax,ā4903
mappedToAkamaiRequestsTotal,ā1607
mappedToOriginRequestsLatest,ā1279
mappedToOriginRequestsMax,ā2089
mappedToOriginRequestsTotal,ā206
#SUMMARYSTATISTICS_END
#COLUMNS_START
startdatetime,ādnsRequests,āgeoMappedToOriginRequests,āmappedToAkamaiRequests,āmappedToOriginRequests
#COLUMNS_END
#DATA_START
2020-06-26T13:40:00Z,1531,ā1578,ā2880,ā855
2020-06-26T13:45:00Z,2396,ā4950,ā3827,ā2210
2020-06-26T13:50:00Z,3883,ā4241,ā1624,ā882
2020-06-26T13:55:00Z,3166,ā2259,ā382,ā1502
#DATA_END
Get report details
This sample Get a report type operation gets the same information you need to run the sxlmapping-by-time
report as provided in this reference documentation, but available dynamically to your API client application.
GET /reporting-api/v1/reports/sxlmapping-by-time/versions/1
Status 200 application/json
Response body:
{
"name": "sxlmapping-by-time",
"description": "The data for DNS requests of any type that were made to process sessions associated with IPA traffic.",
"businessObjectName": "cpcode",
"version": 1,
"status": "PUBLISHED",
"deprecated": false,
"timeBased": true,
"outputType": "FLAT",
"requiredProducts": [
"Session Accelerator"
],
"requiredRoles": [
"Pulsar IPA/SXL Read Only"
],
"available": true,
"metrics": [
{
"name": "dnsRequests",
"description": "The number of DNS requests of any type over time that were made to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served.",
"label": "DNS Requests",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "dnsRequestsLatest",
"description": "The most recent number of DNS requests of any type that were made as a function of time to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served.",
"label": "Latest DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "dnsRequestsMax",
"description": "The highest number of DNS requests of any type that were made as a function of time to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served.",
"label": "Peak DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "dnsRequestsTotal",
"description": "The total number of DNS requests of any type that were made as a function of time to process the various sessions associated with the IPA traffic to and from the origin servers and clients that are being served.",
"label": "Total DNS Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "geoMappedToOriginRequests",
"description": "The number of DNS requests over time that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.",
"label": "Geo Mapped to Origin Requests",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "geoMappedToOriginRequestsLatest",
"description": "The most recent number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.",
"label": "Latest Geo Mapped to Origin Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "geoMappedToOriginRequestsMax",
"description": "The highest number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.",
"label": "Peak Geo Mapped to Origin Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "geoMappedToOriginRequestsTotal",
"description": "The total number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.",
"label": "Total Geo Mapped To Origin Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "mappedToAkamaiRequests",
"description": "The number of DNS requests over time that directed content to be retrieved from Akamai servers.",
"label": "Mapped to Akamai Requests",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "mappedToAkamaiRequestsLatest",
"description": "The most recent number of DNS requests that directed content to be retrieved from Akamai servers.",
"label": "Latest Mapped to Akamai Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "mappedToAkamaiRequestsMax",
"description": "The highest number of DNS requests that directed content to be retrieved from Akamai servers.",
"label": "Peak Mapped to Akamai Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "mappedToAkamaiRequestsTotal",
"description": "The total number of DNS requests that directed content to be retrieved from Akamai servers.",
"label": "Total Mapped To Akamai Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "mappedToOriginRequests",
"description": "The number of DNS requests over time are mapped to retrieve content from an origin server.",
"label": "Mapped to Origin Requests",
"unit": "COUNT",
"summaryStatistic": false
},
{
"name": "mappedToOriginRequestsLatest",
"description": "The most recent number of DNS requests are mapped to retrieve content from an origin server.",
"label": "Latest Mapped to Origin Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "mappedToOriginRequestsMax",
"description": "The highest number of DNS requests are mapped to retrieve content from an origin server.",
"label": "Peak Mapped to Origin Requests",
"unit": "COUNT",
"summaryStatistic": true
},
{
"name": "mappedToOriginRequestsTotal",
"description": "The total number of DNS requests are mapped to retrieve content from an origin server.",
"label": "Total Mapped To Origin Requests",
"unit": "COUNT",
"summaryStatistic": true
}
],
"groupOutlyingValues": {
"enabled": false
},
"groupBy": [
"startdatetime"
],
"filters": [
{
"name": "slot",
"type": "int",
"description": "A unique configuration for a hostname.",
"required": false
}
],
"intervals": [
"MONTH",
"WEEK",
"DAY",
"HOUR",
"FIVE_MINUTES"
],
"dataRetentionDays": 92,
"links": [
{
"rel": "self",
"href": "/reporting-api/v1/reports/sxlmapping-by-time/versions/1"
},
{
"rel": "versions",
"href": "/reporting-api/v1/reports/sxlmapping-by-time/versions"
},
{
"rel": "all-reports",
"href": "/reporting-api/v1/reports"
},
{
"rel": "execute-report",
"href": "/reporting-api/v1/reports/sxlmapping-by-time/versions/1/report-data"
}
]
}