---
title: "Get key metrics"
method: POST
path: "/home/key-metrics"
tags: ["Homepage"]
---

# Get key metrics

`POST /home/key-metrics`

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

## Request body

- object — Request body for fetching key metrics with location filters
  - `locationIds` integer[], nullable — List of location IDs to include
  - `businessIds` integer[], nullable — List of business IDs to include
  - `locationGroupIds` integer[], nullable — List of location group IDs to include
  - `labels` string[], nullable — List of labels to include
  - `excludedLocationIds` integer[], nullable — List of location IDs to exclude
  - `excludedBusinessIds` integer[], nullable — List of business IDs to exclude
  - `excludedLocationGroupIds` integer[], nullable — List of location group IDs to exclude
  - `excludedLabels` string[], nullable — List of labels to exclude
  - `filterCategory` string, nullable — Filter strategy to apply: location-groups, labels, business, or location
  - `query` string, nullable — Search query string depending on filter category

## Response `200`

Key metrics retrieved successfully

- object — Response containing key performance metrics and Google connection status
  - `status` 'DEFAULT' | 'CONFIGURED', required — Overall status of metric data availability
  - `googleConnectionStatus` 'CONNECTED' | 'PARTIALLY_CONNECTED' | 'NOT_CONNECTED', required — Status of the Google Business Profile connection
  - `metrics` object[], required — List of key performance metrics
    - `metricType` string, required — Type of metric
    - `timePeriod` string, required — Time period for the metric
    - `value` number, required — Current metric value
    - `previousValue` number, nullable — Previous period metric value for comparison
    - `deltaPercentage` number, double, nullable — Percentage change from previous to current value
    - `startDate` string, date, nullable — Start date of the metric period
    - `endDate` string, date, nullable — End date of the metric period
    - `deepLink` string, required — Deep link URL to the detailed metrics view
    - `currencyCode` string, nullable — Currency code for monetary metrics

## Other responses

- `400` — Invalid request parameters
- `401` — Unauthorized

---

[API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/versions/ddc577c548ee/schema)