Skip to content
API Reference/
/
Get the keywords for loca...

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api/
Mock Server
https://docs.uberall.com/_mock/apis/swagger/

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 Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Get a list of basic business details

Request

Get a list of basic business details containing "id" and "name", that can be viewed by the current user.

Security
X-API-KEY or Authorization
Query
querystring

Value used to filter the results. The value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".

sortstring

The business property to sort by. Can be "id" or "name".

maxstring

Used for pagination. Maximum number of results per page. Default: 1000

offsetstring

Offset used for pagination. Default: 0

orderstring

Sets the sorting order. Default: "asc".

curl -i -X GET \
  'https://uberall.com/api/locations/businesses?query=string&sort=string&max=string&offset=string&order=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Businesses

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

Business Page Response Model

response.​businessesArray of objects

List of businesses

response.​maxinteger(int32)

Max

response.​offsetinteger(int32)

Offset

response.​countinteger(int64)

Total number of businesses

response.​warningsArray of strings

List of warnings

Response
No content

Get the keywords for locations

Request

Get the keywords for locations

Security
X-API-KEY or Authorization
Query
locationIdsArray of strings

The location ids that should have keywords returned

businessIdsArray of strings

The business ids for the locations that should be returned

excludedLocationIdsArray of strings

List of location ids which should be excluded from keywords search

curl -i -X GET \
  'https://uberall.com/api/locations/keywords?locationIds=string&businessIds=string&excludedLocationIds=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Keywords for locations successfully retrieved

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.​keywordsArray of strings
Response
No content

Get Historical Visibility Index

Request

Get a Visibility Index time series. Only days where the Visibility Index changed will be returned

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the location you want the Visibility Index for

Query
startDatestring(date)

startDate in YYYY-MM-dd

endDatestring(date)

endDate in YYYY-MM-dd

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/visibility-indexes/interesting?startDate=2019-08-24&endDate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Historical visibility indexes successfully retrieved

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.​indexesArray of objects
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "indexes": [ … ]
  }
}

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

Locations

Locations

Operations