duv-by-state

ūüďė

This Reporting API endpoint was decommissioned on October 31, 2023, as part of the Delivery Reports Consolidation initiative. Learn more in the Delivery Reports Consolidation guide.

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

MetricDescription
Data metrics
uniqueVisitorsMaxThe highest number of unique visitors.
uniqueVisitorsStateThe number of unique visitors by US state.

POST request

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

Query parameters

ParameterTypeSampleDescription
Required
startString2020-05-01T00:00: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-01T00: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.

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.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "uniqueVisitorsMax",
        "uniqueVisitorsState"
    ]
}

GET request

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

ParameterTypeSampleDescription
Required
startString2022-06-23T13:55: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.
endString2022-06-23T14:15: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.
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.
metricsStringuniqueVisitorsMax,‚ÄčuniqueVisitorsStateSpecifies 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.

JSON response

Status 200 application/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": {}
}

CSV response

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

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-api/v1/reports/duv-by-state/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/duv-by-state/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/duv-by-state/versions/1/report-data"
        }
    ]
}