Get location scores via GET

Request

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

Query

locationIdsstring or null

Comma-separated location IDs to filter by

businessIdsstring or null

Comma-separated business IDs to filter by

locationGroupIdsstring or null

Comma-separated location group IDs to filter by

labelsstring or null

Comma-separated labels to filter by

excludedLocationIdsstring or null

Comma-separated location IDs to exclude

excludedBusinessIdsstring or null

Comma-separated business IDs to exclude

excludedLocationGroupIdsstring or null

Comma-separated location group IDs to exclude

excludedLabelsstring or null

Comma-separated labels to exclude

filterCategorystring or null

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

includeBenchmarkbooleanrequired

Whether to include benchmark data in the response

Default:false

querystring or null

Search query string depending on filter category

curl -i -X GET \
  'https://uberall.com/api/home/locations/score?locationIds=string&businessIds=string&locationGroupIds=string&labels=string&excludedLocationIds=string&excludedBusinessIds=string&excludedLocationGroupIds=string&excludedLabels=string&filterCategory=string&includeBenchmark=false&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
  }
}