Sign in

v1

OpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Homepage

Get location scores via POST

Retrieves aggregated location scores using filter criteria provided in the request body.

post/home/locations/score

Query parameters

includeBenchmarkboolean required

Whether to include benchmark data in the response

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

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
  }
}