Get location scores via POST

Request

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

Query

includeBenchmarkbooleanrequired

Whether to include benchmark data in the response

Default:false

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/locations/score?includeBenchmark=false' \
  -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

Location scores retrieved successfully

Bodyapplication/json

scoreinteger or null, (int64)

Overall location score

Example:75

maxScoreinteger or null, (int32)

Maximum achievable score

Example:100

productScoresArray of objects or null

List of per-product score breakdowns

pillarScoresobject

Aggregated pillar scores for visibility, reputation, and engagement

benchmarkobject

Benchmark score for comparison against similar locations

upsellProductobject

Upsell product recommendation for improving the score

Response

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