Get available filters for filtering data points

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description

swagger.json

swagger.yaml

Overview

URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Servers

Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Get available filters for filtering data points

Request

Get available filters for filtering data points, which the current api user has access to.

Query

locationIdsArray of strings

Applies a filter of locationIds

userIdstring

Shows the filters of the user with this id

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/filters?locationIds=string&userId=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

statusstringrequired

Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Response object containing various filters for data points

response.directoriesArray of strings

List of directory names

Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"

response.countriesArray of strings

List of countriy names

Items Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

response.businessesArray of objects(BusinessFiltersResponse)

List of business ids and names

response.labelsArray of stringsunique

List of labels

response.timeSpansArray of strings

Items Enum"TODAY""LAST_7_DAYS""LAST_14_DAYS""LAST_30_DAYS""LAST_90_DAYS""LAST_365_DAYS""ALL_TIME"

Response

application/json

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "directories": [ … ],
    "countries": [ … ],
    "businesses": [ … ],
    "labels": [ … ],
    "timeSpans": [ … ]
  }
}

Create a new saved datapoint's filter

Request

Creates a new DataPointFilter

Bodyapplication/jsonrequired

DataPointFilter object that needs to be created

namestringrequired

The filter name

sharedboolean

Defines if the filter is shared or not

directoriesArray of stringsunique

The list of directories for which the dataPoints should be filtered

Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"

countriesArray of stringsunique

The list of countries for which the dataPoints should be filtered

Items Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

dataPointTypesArray of stringsunique

The list of data point types (REVIEW or PHOTO) for which the dataPoints should be filtered

Items Enum"REVIEW""PHOTO""CHECKIN""CONVERSATION""COMMENT""QUESTION""POST""IMAGE""VIDEO""CAROUSEL_ALBUM"

ratingsArray of integers(int32)unique

The list of ratings (1, 2, 3, 4 or 5) for which the dataPoints should be filtered

labelsArray of stringsunique

The list of labels for which the dataPoints should be filtered

isReadboolean

Flag to set when only datapoints should be shown that the current user already read

hasReplyboolean

Flag to set when only datapoints with a reply should be shown

hasTextboolean

Flag to set when only datapoints with text should be shown

querystring

Any combination of words that should be checked in the dataPoints text, reply messages and author

timeSpanstring

The date range for which the dataPoints should be filtered.

Enum"TODAY""LAST_7_DAYS""LAST_14_DAYS""LAST_30_DAYS""LAST_90_DAYS""LAST_365_DAYS""ALL_TIME"

crossfeedFilterIdinteger(int64)

The id of a filter saved by a user in the Feed

businessIdsArray of integers(int64)unique

The list of businesses IDs for which the dataPoints should be filtered

dateEndstring(date-time)

The maximum date for which the dataPoints should be filtered

dateStartstring(date-time)

The minimum date for which the dataPoints should be filtered

ownerIdinteger(int64)

The id of the user that owns the filter

ownerNamestring

The name of the user that owns the filter

salesPartnerIdinteger(int64)

The sales partner to which the filter belongs

subscriberIdsArray of integers(int64)

The list of user's ids that are subscribed to the filter

curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/data-points/filters \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "shared": true,
    "directories": [
      "FOURSQUARE"
    ],
    "countries": [
      "AF"
    ],
    "dataPointTypes": [
      "REVIEW"
    ],
    "ratings": [
      0
    ],
    "labels": [
      "string"
    ],
    "isRead": true,
    "hasReply": true,
    "hasText": true,
    "query": "string",
    "timeSpan": "TODAY",
    "crossfeedFilterId": 0,
    "businessIds": [
      0
    ],
    "dateEnd": "2019-08-24T14:15:22Z",
    "dateStart": "2019-08-24T14:15:22Z",
    "ownerId": 0,
    "ownerName": "string",
    "salesPartnerId": 0,
    "subscriberIds": [
      0
    ]
  }'

Responses

Success

Body*/*

statusstringrequired

Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.dataPointFilterobject

Data Point Filter Model

Response

No content

Get a saved datapoint's filter

Request

The Uberall locationId

Path

idstringrequired

ID of a DataPointFilter

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/filters/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

statusstringrequired

Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.dataPointFilterobject

Data Point Filter Model

Response

application/json

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "dataPointFilter": { … }
  }
}

Templates

Products - Response Library - Templates

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations

Uberall API (20250204)

Users

Business Connections

Businesses

Configuration

Sales Partners

Monitoring

Product Plans

Webhooks

Auto Response

Brand Data Points

Dashboard

Dashboard Exports

Data Points

Data Point Filters

Get available filters for filtering data points

Request

Responses

Was this helpful?

Create a new saved datapoint's filter

Request

Responses

Was this helpful?

Get a saved datapoint's filter

Request

Responses

Was this helpful?

Templates

Social Posting

Social Posting Templates

Digital Asset Management

Status Check

Store Finder

Batch Operation

Categories

Collection Management

Content List

Locations Data

Custom Items

Events

Listings

Labels

Location Groups

Menu Items

Persons

Locations Photos

Products

Service Items

Suggestions