duv-by-state report

The following shows how to generate the duv-by-state 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 daily unique visitor data by US state. When querying multiple days worth of data, you’ll receive the MAX daily value across the entire date range for each of the dimensions.

Business object: cpcode

Data available for: 92 days

Available metrics

Metric Description
Data metrics
uniqueVisitorsMax The highest number of unique visitors.
uniqueVisitorsState The number of unique visitors by US state.

Sample report

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

Sample: /reporting-api/v1/reports/duv-by-state/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-05-01T00: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-01T00: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.

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": [
        "uniqueVisitorsMax",
        "uniqueVisitorsState"
    ]
}

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

Sample: /reporting-api/v1/reports/duv-by-state/versions/1/report-data?start=2020-05-01T00%3A00%3A00Z&end=2020-06-01T00%3A00%3A00Z&objectIds=55232,23433,32433&metrics=uniqueVisitorsMax%2CuniqueVisitorsState

Query parameters

Parameter Type Sample Description
Required
start String 2020-05-01T00: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-01T00:00:00Z Specifies if unavailable reports should be shown.
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 uniqueVisitorsMax,uniqueVisitorsState 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-state",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "geoid"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "geoid"
            },
            {
                "name": "uniqueVisitorsMax",
                "label": "Unique Visitors Maximum"
            },
            {
                "name": "uniqueVisitorsState",
                "label": "Unique Visitors State"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "geoid": "GB",
            "uniqueVisitorsMax": "1812",
            "uniqueVisitorsState": "7323"
        },
        {
            "geoid": "JP",
            "uniqueVisitorsMax": "3756",
            "uniqueVisitorsState": "6978"
        },
        {
            "geoid": "CH",
            "uniqueVisitorsMax": "848",
            "uniqueVisitorsState": "Other"
        },
        {
            "geoid": "ES",
            "uniqueVisitorsMax": "1435",
            "uniqueVisitorsState": "3863"
        }
    ],
    "summaryStatistics": {}
}

Status 200 text/csv

Response Body:

#METADATA_START
name,duv-by-state
version,1
source,duv-by-state/versions/1
groupBy,geoid
start,2020-05-01T00:00:00Z
end,2020-06-01T00:00:00Z
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
#METADATA_END

#SUMMARYSTATISTICS_START

#SUMMARYSTATISTICS_END

#COLUMNS_START
geoid,uniqueVisitorsMax,uniqueVisitorsState
#COLUMNS_END

#DATA_START
GB,1812,7323
JP,3756,6978
CH,848,Other
ES,1435,3863
#DATA_END

Get report details

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

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

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "duv-by-state",
    "description": "Returns daily unique visitor data by US state. When querying multiple days worth of data, you'll receive the MAX daily value across the entire date range for each of the dimensions.",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": false,
    "outputType": "FLAT",
    "requiredProducts": [
        "Basic Traffic Reports"
    ],
    "requiredRoles": [
        "Reports - All privileges",
        "Reports - View only",
        "OTA App User"
    ],
    "available": true,
    "metrics": [
        {
            "name": "uniqueVisitorsMax",
            "description": "The highest number of unique visitors.",
            "label": "Unique Visitors Maximum",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "uniqueVisitorsState",
            "description": "The number of unique visitors by US state.",
            "label": "Unique Visitors State",
            "unit": "STRING",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "geoid"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/duv-by-state/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/duv-by-state/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/duv-by-state/versions/1/report-data"
        }
    ]
}