This module contains a DataStatisticsApi class to perform API operations.

The HERE API reference documentation used in this module can be found here: Statistics API Reference # noqa E501

class here.platform.api.data_statistics_api.DataStatisticsApi(base_url: str, platform_config: PlatformConfig, application_config: ApplicationConfig, auth: Auth | None, proxies: dict | None = None)[source]#

Bases: BaseApi

This class provides access to HERE platform Data Statistics APIs.

Use the statistics service to retrieve statistics for the data coverage of catalogs. It shows where data exists, freshness of the data and other statistics.

get_age_map(layer_id: str, data_level: str) → bytes[source]#

Retrieve HeatMap representing partition size.

Parameters:

  • layer_id – The ID of the index layer you want to query.

  • data_level – One of the Data Levels configured for this layer. By default, assets generated at deepest data level are returned. Note that assets returned for data levels greater than 11 represent data at data level 11.

Returns:

response from the API.

Raises:

PlatformException – If platform responds with an HTTP error.

get_size_map(layer_id: str, data_level: str) → bytes[source]#

Retrieve HeatMap representing partition size.

Parameters:

  • layer_id – The ID of the index layer you want to query.

  • data_level – One of the Data Levels configured for this layer. By default, assets generated at deepest data level are returned. Note that assets returned for data levels greater than 11 represent data at data level 11.

Returns:

response from the API.

Raises:

PlatformException – If platform responds with an HTTP error.

get_summary(layer_id: str) → Any[source]#

Retrieve layer statistics.

Parameters:

layer_id – The layer ID of the index layer.

Returns:

response from the API.

Raises:

PlatformException – If platform responds with an HTTP error.

get_tile_map(layer_id: str, data_level: str) → bytes[source]#

Retrieve bitmap representing availability of data in partitions.

Parameters:

  • layer_id – The ID of the index layer you want to query.

  • data_level – One of the Data Levels configured for this layer. By default, assets generated at deepest data level are returned. Note that assets returned for data levels greater than 11 represent data at data level 11.

Returns:

response from the API.

Raises:

PlatformException – If platform responds with an HTTP error.