---
title: "Get location rankings via POST"
method: POST
path: "/home/locations/ranks"
tags: ["Homepage"]
---

# Get location rankings via POST

`POST /home/locations/ranks`

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

## Query parameters

- `sort` string, required
- `page` integer, required
- `pageSize` integer, required
- `scoreMin` integer, required
- `scoreMax` integer, required
- `normalisedScoreMin` integer, nullable
- `normalisedScoreMax` integer, nullable

## Request body

- object — Request body for filtering locations by various criteria
  - `locationIds` integer[], nullable — List of location IDs to include
  - `businessIds` integer[], nullable — List of business IDs to include
  - `locationGroupIds` integer[], nullable — List of location group IDs to include
  - `labels` string[], nullable — List of labels to include
  - `excludedLocationIds` integer[], nullable — List of location IDs to exclude
  - `excludedBusinessIds` integer[], nullable — List of business IDs to exclude
  - `excludedLocationGroupIds` integer[], nullable — List of location group IDs to exclude
  - `excludedLabels` string[], nullable — List of labels to exclude
  - `filterCategory` string, nullable — Filter strategy to apply: location-groups, labels, business, or location
  - `query` string, nullable — Search query string depending on filter category

## Response `200`

Successfully retrieved location rankings

- object — Paginated response containing location rankings ordered by score
  - `ranks` object[], required — List of ranked locations
    - `locationId` integer — Location identifier
    - `identifier` string, nullable — External identifier for the location
    - `name` string, nullable — Location name
    - `address` string, nullable — Location address
    - `score` integer — Location score
    - `normalisedScore` integer, nullable — Normalised score with a scale of 0-100. Omitted for non-custom sales partners, whose maxScore is 100 so the normalised score always equals score.
  - `page` integer — Current page number
  - `pageSize` integer — Number of items per page
  - `size` integer — Number of items in the current page
  - `totalCount` integer — Total number of ranked locations

## Other responses

- `400` — Invalid request parameters
- `401` — Unauthorized - missing or invalid user headers

---

[API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/versions/ddc577c548ee/schema)