Sign in

v

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0929353914.0 MB
Homepage

Get key metrics

Fetches aggregated key metrics for the authenticated user based on the provided location filters.

post/home/key-metrics

Request body

locationIdsinteger[] nullable

List of location IDs to include

businessIdsinteger[] nullable

List of business IDs to include

locationGroupIdsinteger[] nullable

List of location group IDs to include

labelsstring[] nullable

List of labels to include

excludedLocationIdsinteger[] nullable

List of location IDs to exclude

excludedBusinessIdsinteger[] nullable

List of business IDs to exclude

excludedLocationGroupIdsinteger[] nullable

List of location group IDs to exclude

excludedLabelsstring[] nullable

List of labels to exclude

filterCategorystring nullable

Filter strategy to apply: location-groups, labels, business, or location

querystring nullable

Search query string depending on filter category

Example request

{
  "filterCategory": "business"
}

Response

Key metrics retrieved successfully

status'DEFAULT' | 'CONFIGURED' required

Overall status of metric data availability

googleConnectionStatus'CONNECTED' | 'PARTIALLY_CONNECTED' | 'NOT_CONNECTED' required

Status of the Google Business Profile connection

Example response

{
  "metrics": [
    {
      "metricType": "GOOGLE_SEARCHES",
      "timePeriod": "LAST_30_DAYS",
      "value": 1250,
      "previousValue": 1100,
      "deltaPercentage": 13.6,
      "startDate": "2025-01-01",
      "endDate": "2025-01-31",
      "deepLink": "/analytics/google-searches",
      "currencyCode": "EUR"
    }
  ]
}