Statistics REST API¶

This namespace describes endpoints and data types for obtaining statistics.

Description¶

The statistics API can be used to obtain statistics of a specific release. Our Map Content API provides two different endpoints to obtain statistical information:

List all available statistics for a release
Obtaining a single, specific statistic of a release

List All Statistics Of A Release¶

Get a list of all available statistics for a given release identifier.

Endpoint	/releases/{ID}/statistics
HTTP Methods	GET
Response Content Type	`application/json`
Response Body	`Statistics`

Request Parameters¶

Name	Description	Required
id	A release id	Yes

Example Request¶

curl -X GET https://example.com/releases/39490/statistics
     --header 'Accept: application/json'
     --header 'Authorization: Bearer <api_key>'

GET /releases/39490/statistics HTTP/1.1
Host: example.com
Accept: application/json

{
    "statistics": [
        {
            "id": "10",
            "name": "x_stats_anchor_point_link_postal_point",
            "description": "Number of Postal Points linked to APTs",
            "detailedDescription": "Lengthy description of the statistic",
            "creationDate": "2018-11-04T21:20:30.098070Z",
            "location": "http://example.com/statistics/10"
        }
    ]
}

Get A Statistic By ID¶

Get a statistic in Comma-separated format for a given statistic identifier.

Note

All output formats are encoded in UTF-8.

Request with response in text/csv-format¶

Endpoint	/statistics/{ID}
HTTP Methods	GET
Response Content Type	`text/csv`
Response Body	`Statistic`

Request Parameters¶

Name	Description	Required
id	A statistics id	Yes

Example Request¶

curl -X GET https://example.com/statistics/89c62b45-c50a-4749-6666-3820266e3d9a
     --header 'Accept: text/csv'
     --header 'Authorization: Bearer <api_key>'

GET /statistics/89c62b45-c50a-4749-6666-3820266e3d9a HTTP/1.1
Host: example.com
Accept: text/csv

country_code_char3,country_name,a1_admin_code,a1_admin_name,a8_admin_code,a8_admin_name,table_description,postal_point_present,release_version,model_version,count
AUT,Österreich,1,Burgenland,10101,Eisenstadt,Anchor Points,true,2023.09.000,1.09,3859
AUT,Österreich,1,Burgenland,10201,Rust,Anchor Points,true,2023.09.000,1.09,1073