This endpoint provides a comprehensive list of all the available tables that can be queried using the Batch API. It is a key resource for understanding what data can be extracted via the request-report endpoint.
Response
The response contains a list of TableDescriptor objects, each representing a table that can be queried. Each table includes properties such as available metrics, filters, and data granularity.
TableDescriptor Object
This object describes a table, its column, and its dimensions.
| Property | Description | Example |
|---|---|---|
| table string | The unique name of the table. | "apps" |
| table_granularity Dict[str, GranularityInfo] | The available time granularities for querying the table, each with potential historical data availability. | {"monthly": {"start_date": "2023-08", "end_date": "2024-07"}} |
| table_metrics list[MetricDescriptor] | A list of metrics that can be selected for the table. | ["apps_install_penetration", "sessions"] |
| table_filters list[FilterDescriptor] | A list of filters available for data extraction. | ["domains_filter", "countries_filter"] |
MetricDescriptor Object
A metric is a column under a specific table (also can be thought about as a column), usually it querying a metric will cost data credits.
| Property | Description | Example |
|---|---|---|
| metric_name string | The unique name of the metric. | "apps_install_penetration" |
| type string | The type of the metric (e.g., Boolean, Int, String, etc.). | "Double" |
| supported_granularityDict[str, GranularityInfo] | Time granularities for querying the metric, with historical data availability. | {"monthly": {"start_date": "2023-08", "end_date": "2024-07"}} |
| description string | A description of what the metric represents. | "Measures app penetration." |
| claim string | Optional. Specifies if only certain clients can access the metric based on their package. | "CompanyAnalysisAPI" |
FilterDescriptor Object
A filter is based on a column of a table (usually part of the primary key, e.g domain, country, app, etc..) the descriptor object contains instructions on how the filter behaves and what its limitations are when applying the filter on a table (when requesting a report).
| Property | Description | Example |
|---|---|---|
| name string | The filter's name is used in the request-report endpoint under the filters section. | "countries" |
| key_column string | The target column for filtering. | "country" |
| is_filterable bool | Specifies if the filter is available for use in queries. | true / false |
| is_mandatory bool | Specifies if the filter must be used. | true / false |
| type string | The type of input the filter accepts. | "list", "bool" |
| valid_values List[string] | Optional. Specifies valid values that can be used for the filter. | ["android-phone", "ios-phone", "ios-tablet"] |