ipamapping-by-time

The following shows how to generate the ipamapping-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

Provides 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: IP Application Accelerator

Available metrics

MetricDescription
Data metrics
dnsRequestsThe 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.
geoMappedToOriginRequestsThe number of DNS requests over time that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.
mappedToAkamaiRequestsThe number of DNS requests over time that directed content to be retrieved from Akamai servers.
mappedToOriginRequestsThe number of DNS requests over time are mapped to retrieve content from an origin server.
Summary metrics
dnsRequestsLatestThe 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.
dnsRequestsMaxThe 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.
dnsRequestsTotalThe 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.
geoMappedToOriginRequestsLatestThe most recent number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.
geoMappedToOriginRequestsMaxThe highest number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.
geoMappedToOriginRequestsTotalThe total number of DNS requests that are serviced by the Akamai mapper network and directed to retrieve content from an origin server.
mappedToAkamaiRequestsLatestThe most recent number of DNS requests that directed content to be retrieved from Akamai servers.
mappedToAkamaiRequestsMaxThe highest number of DNS requests that directed content to be retrieved from Akamai servers.
mappedToAkamaiRequestsTotalThe total number of DNS requests that directed content to be retrieved from Akamai servers.
mappedToOriginRequestsLatestThe most recent number of DNS requests are mapped to retrieve content from an origin server.
mappedToOriginRequestsMaxThe highest number of DNS requests are mapped to retrieve content from an origin server.
mappedToOriginRequestsTotalThe total number of DNS requests are mapped to retrieve content from an origin server.

Available filters

FilterTypeDescription
Optional filters
slotIntegerA unique configuration for a hostname.

POST request

POST /reporting-api/v1/reports/ipamapping-by-time/versions/1/report-data{?start,​end,​interval}

Sample: /reporting-api/v1/reports/ipamapping-by-time/versions/1/report-data?start​=2020-06-26T13%3A40%3A00Z​&end​=2020-06-26T14%3A00%3A00Z​&interval​=FIVE_MINUTES

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies 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.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

MemberTypeDescription
objectIdsArraySpecifies the set of cpcode values you want to report on.
objectIdsEnumerationAs an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metricsArrayThe set of desired metrics. If omitted, the report includes all available metrics.
filtersMap of ArraysSpecifies 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",
            "140"
        ]
    }
}

GET request

GET /reporting-api/v1/reports/ipamapping-by-time/versions/1/report-data{?start,​end,​interval,​objectIds,​allObjectIds,​metrics,​filters}

Sample: /reporting-api/v1/reports/ipamapping-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%3D11838%2Cslot%3D140

Query parameters

ParameterTypeSampleDescription
Required
startString2020-06-26T13:40:00ZSpecifies 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.
endString2020-06-26T14:00:00ZSpecifies if unavailable reports should be shown.
intervalEnumerationFIVE_MINUTESThe duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIdsBooleantrueAs 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.
objectIdsString55232,​23433,​32433As 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.
metricsStringdnsRequests,​dnsRequestsLatestSpecifies 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.
filtersStringslot=​11838,​slot=​140Specifies 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": "ipamapping-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": [
                    "8927",
                    "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": "1232",
            "geoMappedToOriginRequests": "4042",
            "mappedToAkamaiRequests": "1852",
            "mappedToOriginRequests": "3862"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "dnsRequests": "972",
            "geoMappedToOriginRequests": "1668",
            "mappedToAkamaiRequests": "4745",
            "mappedToOriginRequests": "2829"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "dnsRequests": "2157",
            "geoMappedToOriginRequests": "3548",
            "mappedToAkamaiRequests": "4321",
            "mappedToOriginRequests": "1099"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "dnsRequests": "3003",
            "geoMappedToOriginRequests": "2419",
            "mappedToAkamaiRequests": "2346",
            "mappedToOriginRequests": "1021"
        }
    ],
    "summaryStatistics": {
        "dnsRequestsLatest": {
            "value": "1727",
            "details": {}
        },
        "dnsRequestsMax": {
            "value": "657",
            "details": {}
        },
        "dnsRequestsTotal": {
            "value": "1674",
            "details": {}
        },
        "geoMappedToOriginRequestsLatest": {
            "value": "4910",
            "details": {}
        },
        "geoMappedToOriginRequestsMax": {
            "value": "3760",
            "details": {}
        },
        "geoMappedToOriginRequestsTotal": {
            "value": "3633",
            "details": {}
        },
        "mappedToAkamaiRequestsLatest": {
            "value": "1215",
            "details": {}
        },
        "mappedToAkamaiRequestsMax": {
            "value": "2572",
            "details": {}
        },
        "mappedToAkamaiRequestsTotal": {
            "value": "3735",
            "details": {}
        },
        "mappedToOriginRequestsLatest": {
            "value": "2600",
            "details": {}
        },
        "mappedToOriginRequestsMax": {
            "value": "3669",
            "details": {}
        },
        "mappedToOriginRequestsTotal": {
            "value": "55",
            "details": {}
        }
    }
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​ipamapping-by-time
version,​1
source,​ipamapping-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,​8927,​140
#METADATA_END

#SUMMARYSTATISTICS_START
dnsRequestsLatest,​1727
dnsRequestsMax,​657
dnsRequestsTotal,​1674
geoMappedToOriginRequestsLatest,​4910
geoMappedToOriginRequestsMax,​3760
geoMappedToOriginRequestsTotal,​3633
mappedToAkamaiRequestsLatest,​1215
mappedToAkamaiRequestsMax,​2572
mappedToAkamaiRequestsTotal,​3735
mappedToOriginRequestsLatest,​2600
mappedToOriginRequestsMax,​3669
mappedToOriginRequestsTotal,​55
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,​dnsRequests,​geoMappedToOriginRequests,​mappedToAkamaiRequests,​mappedToOriginRequests
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,1232,​4042,​1852,​3862
2020-06-26T13:45:00Z,972,​1668,​4745,​2829
2020-06-26T13:50:00Z,2157,​3548,​4321,​1099
2020-06-26T13:55:00Z,3003,​2419,​2346,​1021
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the ipamapping-by-time report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/ipamapping-by-time/versions/1

Status 200 application/json

Response body:

{
    "name": "ipamapping-by-time",
    "description": "Provides 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": [
        "IP Application 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/ipamapping-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/ipamapping-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/ipamapping-by-time/versions/1/report-data"
        }
    ]
}