---
title: "Get location scores via GET"
method: GET
path: "/home/locations/score"
tags: ["Homepage"]
---

# Get location scores via GET

`GET /home/locations/score`

Retrieves aggregated location scores using filter criteria provided as query parameters.

## Query parameters

- `locationIds` string, nullable
- `businessIds` string, nullable
- `locationGroupIds` string, nullable
- `labels` string, nullable
- `excludedLocationIds` string, nullable
- `excludedBusinessIds` string, nullable
- `excludedLocationGroupIds` string, nullable
- `excludedLabels` string, nullable
- `filterCategory` string, nullable
- `includeBenchmark` boolean, required
- `query` string, nullable

## Response `200`

Location scores retrieved successfully

- object — Response containing the overall location score, per-product scores, pillar scores, benchmark, and upsell information
  - `score` integer, nullable — Overall location score
  - `maxScore` integer, nullable — Maximum achievable score
  - `productScores` object[], nullable — List of per-product score breakdowns
    - `name` string, required — Product name
    - `completedPercentage` integer — Percentage of score completed for this product
  - `pillarScores` object — Aggregated pillar scores for visibility, reputation, and engagement
    - `visibility` integer, nullable — Visibility pillar score (0-100)
    - `reputation` integer, nullable — Reputation pillar score (0-100)
    - `engagement` integer, nullable — Engagement pillar score (0-100)
  - `benchmark` object — Benchmark score for comparison against similar locations
    - `categoryId` integer, nullable — Category identifier
    - `score` integer, nullable — Benchmark score value
  - `upsellProduct` object — Upsell product recommendation for improving the score
    - `product` string, required — Product identifier
    - `maxValue` integer — Maximum score value the product can contribute
    - `trialAvailable` boolean — Whether a free trial is available for this product
    - `isRequested` boolean — Whether the product has already been requested

## 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/a506e82d7cbe/schema)