The following shows how to generate the hits-by-os 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 traffic data by operating system

This report yields the top nine values. Remaining values are grouped as a single record titled Other. Use the dataWrapNumberOfItems parameter to control the number of items to report separately, and the dataWrapLabel parameter to identify the remaining group.

Business object: cpcode

Data available for: 92 days

Available metrics

POST request

POST /reporting-api/v1/reports/hits-by-os/versions/1/report-data{?start,​end,​dataWrapNumberOfItems,​dataWrapLabel}

Sample: /reporting-api/v1/reports/hits-by-os/versions/1/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&dataWrapNumberOfItems​=2​&dataWrapLabel​=Other

Query parameters

JSON request members

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "successfulHits",
        "successfulHitsPercent"
    ]
}

GET request

GET /reporting-api/v1/reports/hits-by-os/versions/1/report-data{?start,​end,​objectIds,​allObjectIds,​metrics,​dataWrapNumberOfItems,​dataWrapLabel}

Sample: /reporting-api/v1/reports/hits-by-os/versions/1/report-data?start​=2020-05-01T00%3A00%3A00Z​&end​=2020-06-01T00%3A00%3A00Z​&objectIds​=55232,​23433,​32433​&metrics​=successfulHits%2CsuccessfulHitsPercent​&dataWrapNumberOfItems​=2​&dataWrapLabel​=Other

Query parameters

JSON response

Status 200 application/json

Response body:

{
    "metadata": {
        "name": "hits-by-os",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "os_version"
        ],
        "start": "2020-05-01T00:00:00Z",
        "end": "2020-06-01T00:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [],
        "columns": [
            {
                "name": "groupBy",
                "label": "os_version"
            },
            {
                "name": "successfulHits",
                "label": "Successful Hits "
            },
            {
                "name": "successfulHitsPercent",
                "label": "Successful Hits %"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "os_version": "Mojave (10.14)",
            "successfulHits": "2617",
            "successfulHitsPercent": "97"
        },
        {
            "os_version": "iOS 12 (12.0)",
            "successfulHits": "1547",
            "successfulHitsPercent": "39"
        },
        {
            "os_version": "Other",
            "successfulHits": "831",
            "successfulHitsPercent": "73"
        }
    ],
    "summaryStatistics": {}
}

CSV response

Status 200 text/csv

Response Body:

#METADATA_START
name,​hits-by-os
version,​1
source,​hits-by-os/versions/1
groupBy,​os_version
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
os_version,​successfulHits,​successfulHitsPercent
#COLUMNS_END

#DATA_START
Mojave (10.14),2617,​97
iOS 12 (12.0),1547,​39
Other,​831,​73
#DATA_END

Get report details

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

GET /reporting-api/v1/reports/hits-by-os/versions/1

Status 200 application/json

Response body:

{
    "name": "hits-by-os",
    "description": "Returns traffic data by operating system",
    "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": "successfulHits",
            "description": "The number of requests returning successful responses.",
            "label": "Successful Hits ",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "successfulHitsPercent",
            "description": "The percent of total number of requests returning successful responses for that operating system.",
            "label": "Successful Hits %",
            "unit": "RATIO",
            "summaryStatistic": false
        }
    ],
    "groupOutlyingValues": {
        "enabled": true,
        "groupThreshold": 9,
        "groupName": "Other"
    },
    "groupBy": [
        "os_version"
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY"
    ],
    "dataRetentionDays": 92,
    "limit": 10000,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-api/v1/reports/hits-by-os/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-api/v1/reports/hits-by-os/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-api/v1/reports/hits-by-os/versions/1/report-data"
        }
    ]
}