Skip to content
API Reference/
/
DEPRECATED - Get Location...

Uberall API (20260101)

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 AI Service

Products - Social AI Service

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 Location's Visibility Index

Request

Get the latest location's visibility index

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

Query
daysstring

Use days to get the visibility index from as many days ago

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/visibility-indexes?days=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

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.​visibilityIndexobject

VisibilityIndex Model

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "visibilityIndex": { … }
  }
}

DEPRECATED - Get Location's Data PointsDeprecated

Request

Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points-GET instead.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique ID of the location you want to inbox items for

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/datapoints' \
  -H 'X-API-KEY: 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.​inboxobject

Inbox Response Model

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "inbox": { … }
  }
}

DEPRECATED - Get Location's Data Point StatisticsDeprecated

Request

Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points_statistics-GET instead.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique ID of the location

Query
dataPointTypesArray of strings

Types of datapoints you want inbox statistics for

Example: dataPointTypes=[PHOTO, REVIEW, CHECKIN]
directoryTypesArray of strings

Directories you want inbox statistics for

ratingsArray of strings

Ratings of datapoints you want inbox statistics for.

minActionDatestring

Only consider data points created after that date

maxActionDatestring

Only consider data points created before that date

minThreadActionDatestring

The min date of the last interaction with a DataPoint as unix timestamp in milliseconds

Example: minThreadActionDate=1514764800000
maxThreadActionDatestring

The max date of the last interaction with a DataPoint as unix timestamp in millisecond

Example: maxThreadActionDate=1514764800000
curl -i -X GET \
  'https://uberall.com/api/locations/{id}/datapoints/statistics?dataPointTypes=%5BPHOTO%2C+REVIEW%2C+CHECKIN%5D&directoryTypes=string&ratings=string&minActionDate=string&maxActionDate=string&minThreadActionDate=1514764800000&maxThreadActionDate=1514764800000' \
  -H 'X-API-KEY: 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

Datapoint statistics response Model

Example: [{"totalCount":100,"photoCount":20,"postCount":30,"reviewCount":25,"checkinCount":10,"questionCount":5,"ratingCount":15,"unreadCount":8,"pendingApprovalCount":3,"averageRating":4.2,"directories":{"GOOGLE":{"REVIEW":10,"PHOTO":5,"QUESTION":2,"CHECKIN":"NOT_SUPPORTED"},"FACEBOOK":{"REVIEW":8,"PHOTO":3,"CHECKIN":12,"QUESTION":0}}}]
response.​totalCountinteger(int32)

Total number of datapoints

response.​photoCountinteger(int32)

Number of photos

response.​postCountinteger(int32)

Number of posts

response.​reviewCountinteger(int32)

Number of reviews

response.​checkinCountinteger(int32)

Number of checkins

response.​questionCountinteger(int32)

Number of questions

response.​ratingCountinteger(int32)

Number of ratings

response.​unreadCountinteger(int32)

Number of unread datapoints

response.​pendingApprovalCountinteger(int32)

Number of replies pending approval

response.​averageRatingnumber(float)

Average rating obtained

response.​directoriesobject

Breakdown by directory

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": [
    { … }
  ]
}

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