Get suggestions via POST

API Reference/

Request

Retrieves a paginated list of suggestions for the user, using a POST body for location filter criteria.

Query

pageinteger, (int32)required

Page number (zero-based)

Default:0

pageSizeinteger, (int32)required

Number of suggestions per page

Default:10

productsstring or null

Comma-separated list of product filters

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/suggestions?page=0&pageSize=10&products=string' \
  -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 suggestions

Bodyapplication/json

suggestionsArray of objectsrequired

List of suggestions

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 suggestions

Example:25

Response

{
  "suggestions": [
    { … }
  ],
  "page": 0,
  "pageSize": 10,
  "size": 10,
  "totalCount": 25
}