duv-by-time report

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

Returns visitor data over time.

This report allows you to configure the aggregation interval for each data record. Available interval values are: MONTH, WEEK, DAY.

Business object: cpcode

Data available for: 92 days

Available metrics

Metric Description
Data metrics
allUniqueVisitors The total number of unique combinations of client IP addresses plus User Agent (or player ID for streaming).
ipv4UniqueVisitors The number of unique combinations of client IPv4 addresses plus User Agent.
ipv6UniqueVisitors The number of unique combinations of client IPv6 addresses plus User Agent.
Summary metrics
allUniqueVisitorsAverage The average number of unique combinations of client IP addresses plus User Agent (or player ID for streaming).
allUniqueVisitorsMax The highest number of unique combinations of client IP addresses plus User Agent (or player ID for streaming)
allUniqueVisitorsMin The lowest number of unique combinations of client IP addresses plus User Agent (or player ID for streaming)
allUniqueVisitorsSlope Represents the overall change in the unique combinations of client IP addresses plus User Agent (or player ID for streaming) over time, a positive number if increasing or a negative number if decreasing.
ipv4UniqueVisitorsAverage The average number of unique combinations of client IPv4 addresses plus User Agent.
ipv4UniqueVisitorsMax The highest number of unique combinations of client IPv4 addresses plus User Agent.
ipv4UniqueVisitorsMin The lowest number of unique combinations of client IPv4 addresses plus User Agent.
ipv4UniqueVisitorsSlope Represents the overall change in the unique combinations of client IPv4 addresses plus User Agent (or player ID for streaming) over time, a positive number if increasing or a negative number if decreasing.
ipv6UniqueVisitorsAverage The average number of unique combinations of client IPv6 addresses plus User Agent.
ipv6UniqueVisitorsMax The highest number of unique combinations of client IPv6 addresses plus User Agent.
ipv6UniqueVisitorsMin The lowest number of unique combinations of client IPv6 addresses plus User Agent.
ipv6UniqueVisitorsSlope Represents the overall change in the unique combinations of client IPv6 addresses plus User Agent (or player ID for streaming) over time, a positive number if increasing or a negative number if decreasing.

Sample report

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

Sample: /reporting-api/v1/reports/duv-by-time/versions/1/report-data?start=2020-06-22T00%3A00%3A00Z&end=2020-06-26T00%3A00%3A00Z&interval=DAY

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-22T00:00: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-26T00: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 DAY The duration of each data record. Available values: MONTH, WEEK, DAY.

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.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "allUniqueVisitors",
        "allUniqueVisitorsAverage",
        "allUniqueVisitorsMax",
        "allUniqueVisitorsMin",
        "allUniqueVisitorsSlope",
        "ipv4UniqueVisitors",
        "ipv4UniqueVisitorsAverage",
        "ipv4UniqueVisitorsMax",
        "ipv4UniqueVisitorsMin",
        "ipv4UniqueVisitorsSlope",
        "ipv6UniqueVisitors",
        "ipv6UniqueVisitorsAverage",
        "ipv6UniqueVisitorsMax",
        "ipv6UniqueVisitorsMin",
        "ipv6UniqueVisitorsSlope"
    ]
}

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

Sample: /reporting-api/v1/reports/duv-by-time/versions/1/report-data?start=2020-06-22T00%3A00%3A00Z&end=2020-06-26T00%3A00%3A00Z&interval=DAY&objectIds=55232,23433,32433&metrics=allUniqueVisitors%2CallUniqueVisitorsAverage

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-22T00: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.
end String 2020-06-26T00:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration DAY The duration of each data record. Available values: MONTH, WEEK, DAY.
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 allUniqueVisitors,allUniqueVisitorsAverage 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.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "duv-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "DAY",
        "start": "2020-06-22T00:00:00Z",
        "end": "2020-06-26T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "allUniqueVisitors",
                "label": "Unique Visitors"
            },
            {
                "name": "ipv4UniqueVisitors",
                "label": "Unique Visitors"
            },
            {
                "name": "ipv6UniqueVisitors",
                "label": "Unique Visitors"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-22T00:00:00Z",
            "allUniqueVisitors": "3114",
            "ipv4UniqueVisitors": "1184",
            "ipv6UniqueVisitors": "3113"
        },
        {
            "startdatetime": "2020-06-23T00:00:00Z",
            "allUniqueVisitors": "551",
            "ipv4UniqueVisitors": "2116",
            "ipv6UniqueVisitors": "1705"
        },
        {
            "startdatetime": "2020-06-24T00:00:00Z",
            "allUniqueVisitors": "880",
            "ipv4UniqueVisitors": "2109",
            "ipv6UniqueVisitors": "1209"
        },
        {
            "startdatetime": "2020-06-25T00:00:00Z",
            "allUniqueVisitors": "478",
            "ipv4UniqueVisitors": "1120",
            "ipv6UniqueVisitors": "4556"
        }
    ],
    "summaryStatistics": {
        "allUniqueVisitorsAverage": {
            "value": "1286",
            "details": {}
        },
        "allUniqueVisitorsMax": {
            "value": "4577",
            "details": {}
        },
        "allUniqueVisitorsMin": {
            "value": "1556",
            "details": {}
        },
        "allUniqueVisitorsSlope": {
            "value": "1573",
            "details": {}
        },
        "ipv4UniqueVisitorsAverage": {
            "value": "118",
            "details": {}
        },
        "ipv4UniqueVisitorsMax": {
            "value": "475",
            "details": {}
        },
        "ipv4UniqueVisitorsMin": {
            "value": "3443",
            "details": {}
        },
        "ipv4UniqueVisitorsSlope": {
            "value": "168",
            "details": {}
        },
        "ipv6UniqueVisitorsAverage": {
            "value": "3241",
            "details": {}
        },
        "ipv6UniqueVisitorsMax": {
            "value": "2923",
            "details": {}
        },
        "ipv6UniqueVisitorsMin": {
            "value": "2942",
            "details": {}
        },
        "ipv6UniqueVisitorsSlope": {
            "value": "91",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,duv-by-time
version,1
source,duv-by-time/versions/1
groupBy,startdatetime
start,2020-06-22T00:00:00Z
end,2020-06-26T00:00:00Z
interval,`DAY`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
#METADATA_END

#SUMMARYSTATISTICS_START
allUniqueVisitorsAverage,1286
allUniqueVisitorsMax,4577
allUniqueVisitorsMin,1556
allUniqueVisitorsSlope,1573
ipv4UniqueVisitorsAverage,118
ipv4UniqueVisitorsMax,475
ipv4UniqueVisitorsMin,3443
ipv4UniqueVisitorsSlope,168
ipv6UniqueVisitorsAverage,3241
ipv6UniqueVisitorsMax,2923
ipv6UniqueVisitorsMin,2942
ipv6UniqueVisitorsSlope,91
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,allUniqueVisitors,ipv4UniqueVisitors,ipv6UniqueVisitors
#COLUMNS_END

#DATA_START
2020-06-22T00:00:00Z,3114,1184,3113
2020-06-23T00:00:00Z,551,2116,1705
2020-06-24T00:00:00Z,880,2109,1209
2020-06-25T00:00:00Z,478,1120,4556
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "duv-by-time",
    "description": "Returns visitor data over time. ",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges ",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "allUniqueVisitors",
            "description": "The total number of unique combinations of client IP addresses plus User Agent (or player ID for streaming).",
            "label": "Unique Visitors",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "allUniqueVisitorsAverage",
            "description": "The average number of unique combinations of client IP addresses plus User Agent (or player ID for streaming).",
            "label": "Unique Visitors Average",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allUniqueVisitorsMax",
            "description": "The highest number of unique combinations of client IP addresses plus User Agent (or player ID for streaming)",
            "label": "Unique Visitors Maximum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allUniqueVisitorsMin",
            "description": "The lowest number of unique combinations of client IP addresses plus User Agent (or player ID for streaming)",
            "label": "Unique Visitors Minimum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "allUniqueVisitorsSlope",
            "description": "Represents the overall change in the unique combinations of client IP addresses plus User Agent (or player ID for streaming) over time, a positive number if increasing or a negative number if decreasing.",
            "label": "Unique Visitors Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv4UniqueVisitors",
            "description": "The number of unique combinations of client IPv4 addresses plus User Agent.",
            "label": "Unique Visitors",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "ipv4UniqueVisitorsAverage",
            "description": "The average number of unique combinations of client IPv4 addresses plus User Agent.",
            "label": "Unique Visitors Average",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv4UniqueVisitorsMax",
            "description": "The highest number of unique combinations of client IPv4 addresses plus User Agent.",
            "label": "Unique Visitors Maximum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv4UniqueVisitorsMin",
            "description": "The lowest number of unique combinations of client IPv4 addresses plus User Agent.",
            "label": "Unique Visitors Minimum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv4UniqueVisitorsSlope",
            "description": "Represents the overall change in the unique combinations of client IPv4 addresses plus User Agent (or player ID for streaming) over time, a positive number if increasing or a negative number if decreasing.",
            "label": "Unique Visitors Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv6UniqueVisitors",
            "description": "The number of unique combinations of client IPv6 addresses plus User Agent.",
            "label": "Unique Visitors",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "ipv6UniqueVisitorsAverage",
            "description": "The average number of unique combinations of client IPv6 addresses plus User Agent.",
            "label": "Unique Visitors Average",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv6UniqueVisitorsMax",
            "description": "The highest number of unique combinations of client IPv6 addresses plus User Agent.",
            "label": "Unique Visitors Maximum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv6UniqueVisitorsMin",
            "description": "The lowest number of unique combinations of client IPv6 addresses plus User Agent.",
            "label": "Unique Visitors Minimum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "ipv6UniqueVisitorsSlope",
            "description": "Represents the overall change in the unique combinations of client IPv6 addresses plus User Agent (or player ID for streaming) over time, a positive number if increasing or a negative number if decreasing.",
            "label": "Unique Visitors Slope",
            "unit": "COUNT",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/duv-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/duv-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/duv-by-time/versions/1/report-data"
        }
    ]
}