Get location rankings via POST

API Reference/

Get location rankings via POST

Request

Retrieves a paginated ranking of locations based on their scores, using a POST body for filter criteria.

Query

sortstringrequired

Sort direction (asc or desc)

Default:"desc"

pageinteger, (int32)required

Page number (zero-based)

Default:0

pageSizeinteger, (int32)required

Number of results per page

Default:10

scoreMininteger, (int32)required

Minimum score filter (inclusive)

Default:0

scoreMaxinteger, (int32)required

Maximum score filter (inclusive)

Default:100

normalisedScoreMininteger or null, (int32)

Minimum normalised score filter (inclusive). When set, results are ordered by normalised score.

normalisedScoreMaxinteger or null, (int32)

Maximum normalised score filter (inclusive). When set, results are ordered by normalised score.

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/ranks?sort=desc&page=0&pageSize=10&scoreMin=0&scoreMax=100&normalisedScoreMin=0&normalisedScoreMax=0' \
  -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

Successfully retrieved location rankings

Bodyapplication/json

ranksArray of objectsrequired

List of ranked locations

pageinteger, (int32)

Current page number

Example:0

pageSizeinteger, (int32)

Number of items per page

Example:10

sizeinteger, (int32)

Number of items in the current page

Example:10

totalCountinteger, (int64)

Total number of ranked locations

Example:150

Response

{
  "ranks": [
    { … }
  ],
  "page": 0,
  "pageSize": 10,
  "size": 10,
  "totalCount": 150
}