v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB

Homepage

Get location scores via GET

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

get/home/locations/score

Query parameters

locationIdsstring nullable

Comma-separated location IDs to filter by

businessIdsstring nullable

Comma-separated business IDs to filter by

locationGroupIdsstring nullable

Comma-separated location group IDs to filter by

labelsstring nullable

Comma-separated labels to filter by

excludedLocationIdsstring nullable

Comma-separated location IDs to exclude

excludedBusinessIdsstring nullable

Comma-separated business IDs to exclude

excludedLocationGroupIdsstring nullable

Comma-separated location group IDs to exclude

excludedLabelsstring nullable

Comma-separated labels to exclude

filterCategorystring nullable

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

includeBenchmarkboolean required

Whether to include benchmark data in the response

querystring nullable

Search query string depending on filter category

Response

Location scores retrieved successfully

scoreinteger nullable

Overall location score

maxScoreinteger nullable

Maximum achievable score

Example response

{
  "score": 75,
  "maxScore": 100,
  "productScores": [
    {
      "name": "listingHealth",
      "completedPercentage": 85
    }
  ],
  "pillarScores": {
    "visibility": 72,
    "reputation": 88,
    "engagement": 65
  },
  "benchmark": {
    "categoryId": 12345,
    "score": 78
  },
  "upsellProduct": {
    "product": "socialPosts",
    "maxValue": 20,
    "trialAvailable": true
  }
}