📘

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-country 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 country or area. 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

POST request

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

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

Query parameters

JSON request members

Request body:

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

GET request

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

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

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "duv-by-country",
        "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": "uniqueVisitorsCountry",
                "label": "Unique Visitors Country"
            },
            {
                "name": "uniqueVisitorsMax",
                "label": "Unique Visitors Maximum"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "geoid": "ES",
            "uniqueVisitorsCountry": "ES",
            "uniqueVisitorsMax": "3464"
        },
        {
            "geoid": "GB",
            "uniqueVisitorsCountry": "GB",
            "uniqueVisitorsMax": "3955"
        },
        {
            "geoid": "CA",
            "uniqueVisitorsCountry": "Other",
            "uniqueVisitorsMax": "1014"
        },
        {
            "geoid": "DE",
            "uniqueVisitorsCountry": "JP",
            "uniqueVisitorsMax": "24"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​duv-by-country
version,​1
source,​duv-by-country/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,​uniqueVisitorsCountry,​uniqueVisitorsMax
#COLUMNS_END

#DATA_START
ES,ES,3464
GB,GB,3955
CA,Other,​1014
DE,JP,24
#DATA_END

Get report details

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

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

Status 200 application/json

Response body:

{
    "name": "duv-by-country",
    "description": "Returns daily unique visitor data by country or area. 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": "uniqueVisitorsCountry",
            "description": "The number of unique visitors by country or area.",
            "label": "Unique Visitors Country",
            "unit": "STRING",
            "summaryStatistic": false
        },
        {
            "name": "uniqueVisitorsMax",
            "description": "The highest number of unique visitors.",
            "label": "Unique Visitors Maximum",
            "unit": "COUNT",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "geoid"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/duv-by-country/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/duv-by-country/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/duv-by-country/versions/1/report-data"
        }
    ]
}