Skip to content
API Reference/
/
Get key metrics

Get key metrics

Request

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

Bodyapplication/jsonrequired
locationIdsArray of integers or null, (int64)

List of location IDs to include

businessIdsArray of integers or null, (int64)

List of business IDs to include

locationGroupIdsArray of integers or null, (int64)

List of location group IDs to include

labelsArray of strings or null

List of labels to include

Example:"[\"premium\", \"flagship\"]"
excludedLocationIdsArray of integers or null, (int64)

List of location IDs to exclude

excludedBusinessIdsArray of integers or null, (int64)

List of business IDs to exclude

excludedLocationGroupIdsArray of integers or null, (int64)

List of location group IDs to exclude

excludedLabelsArray of strings or null

List of labels to exclude

filterCategorystring or null

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

Example:"business"
querystring or null

Search query string depending on filter category

curl -i -X POST \
  https://uberall.com/api/home/key-metrics \
  -H 'Content-Type: application/json' \
  -d '{
    "locationIds": [
      0
    ],
    "businessIds": [
      0
    ],
    "locationGroupIds": [
      0
    ],
    "labels": "[\"premium\", \"flagship\"]",
    "excludedLocationIds": [
      0
    ],
    "excludedBusinessIds": [
      0
    ],
    "excludedLocationGroupIds": [
      0
    ],
    "excludedLabels": [
      "string"
    ],
    "filterCategory": "business",
    "query": "string"
  }'

Responses

Key metrics retrieved successfully

Bodyapplication/json
statusstringrequired

Overall status of metric data availability

Enum:"DEFAULT""CONFIGURED"
googleConnectionStatusstringrequired

Status of the Google Business Profile connection

Enum:"CONNECTED""PARTIALLY_CONNECTED""NOT_CONNECTED"
metricsArray of objectsrequired

List of key performance metrics

Response
{
  "status": "DEFAULT",
  "googleConnectionStatus": "CONNECTED",
  "metrics": [
    { … }
  ]
}