v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB

Homepage

Get location rankings via POST

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

post/home/locations/ranks

Query parameters

sortstring required

Sort direction (asc or desc)

pageinteger required

Page number (zero-based)

pageSizeinteger required

Number of results per page

scoreMininteger required

Minimum score filter (inclusive)

scoreMaxinteger required

Maximum score filter (inclusive)

normalisedScoreMininteger nullable

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

normalisedScoreMaxinteger nullable

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

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

Successfully retrieved location rankings

pageinteger

Current page number

pageSizeinteger

Number of items per page

sizeinteger

Number of items in the current page

totalCountinteger

Total number of ranked locations

Example response

{
  "ranks": [
    {
      "locationId": 98765,
      "identifier": "LOC-001",
      "name": "Main Street Store",
      "address": "123 Main St, Berlin",
      "score": 85,
      "normalisedScore": 85
    }
  ],
  "pageSize": 10,
  "size": 10,
  "totalCount": 150
}