Skip to content
API Reference
/
Dashboard
/
Get Listing Health

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

Languages
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

Get Insights Warnings

Request

Get the Insights warnings. The list of locations/accounts connected/unconnected, which need a user action to be able collecting insights for.

Security
accessToken or privateKey
Query
businessIdsArray of integers(int64)

The ids of the businesses you want insights data warnings for

locationIdsArray of integers(int64)

The ids of the locations you want insights data warnings for

textFilterstring

Filter locations to get insights data warnings for by name, zip, street, city, label

Example: textFilter=Berlin
typestring

The directory you want insights warnings for

maxinteger(int64)

Used for pagination. Maximum number of results per page

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard/insights-data/warnings?businessIds=0&locationIds=0&textFilter=Berlin&type=string&max=0&offset=0' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved insights data warnings

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

UserMissingConnectionWarnings Model

Example: {"connectedLocations":[{"type":"GOOGLE","count":100},{"type":"FACEBOOK","count":50}],"notConnectedLocations":[{"type":"GOOGLE","count":5},{"type":"FACEBOOK","count":10}],"warnings":{"missingConnection":{"locations":[{"id":1,"type":"FACEBOOK","name":"Example Location","city":"Sample City","country":"XX","addressLine1":"123 Sample Street"},{"id":2,"type":"GOOGLE","name":"Another Location","city":"Testville","country":"XX","addressLine1":"456 Test Road"}],"totalLocationsCount":10,"totalBusinessesCount":1},"missingPermission":{"accounts":[],"totalLocationsCount":0}},"totalItemsCount":160,"max":20,"offset":0}
response.​warningsobject

A Map with keys as missingConnection and missingPermission. missingConnection is a Map with list of all connections missing connection. missingPermission is a Map with the list of accounts connected, but missing a required permission for insights.

Example: {"missingConnection":{"locations":[{"id":1,"type":"FACEBOOK","name":"Example Location","city":"Sample City","country":"XX","addressLine1":"123 Sample Street"},{"id":2,"type":"GOOGLE","name":"Another Location","city":"Testville","country":"XX","addressLine1":"456 Test Road"}],"totalLocationsCount":10,"totalBusinessesCount":1},"missingPermission":{"accounts":[],"totalLocationsCount":0}}
response.​totalItemsCountinteger(int32)

Used for pagination. Total number of results of the request

Example: 160
response.​maxinteger(int32)

Used for pagination. Maximum number of results per page

Example: 20
response.​offsetinteger(int32)

Offset used for pagination. Default: 0

response.​connectedLocationsArray of objects(ConnectedLocationsDetails)

A Map with key as directory types and values the number of connected locations

Example: [{"type":"GOOGLE","count":100},{"type":"FACEBOOK","count":50}]
response.​notConnectedLocationsArray of objects(ConnectedLocationsDetails)

A Map with key as directory types and values the number of not connected locations

Example: [{"type":"GOOGLE","count":5},{"type":"FACEBOOK","count":10}]
Response
No content

Get Listing Health

Request

Get the Listing Health for the locations managed by the current user

Security
accessToken or privateKey
Path
idinteger(int64)required

The id of the location you want the listing health for

Query
locationIdsArray of integers(int64)

The ids of the locations you want listing health data for

businessIdsArray of integers(int64)

The ids of the businesses you want listing health for

typestring

The directory you want listing health data for

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard/listing-health/{id}?locationIds=0&businessIds=0&type=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successful operation

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

ListingHealth Model

response.​countListingsInSyncinteger(int32)

The number of listings in sync

response.​countListingsSubmittedinteger(int32)

The number of listings in successfully submitted. These listings don't have live sync checks.

response.​countListingsBeingUpdatedinteger(int32)

The number of listings which are in the process of being updated

response.​countListingsLinkedinteger(int32)

The number of listings which have been linked. These listings do not get updated.

response.​countListingsActionRequiredinteger(int32)

The number of listings where client action is required.

response.​countLocationsRequireSyncinteger(int32)

The number of locations which require to be syncronized

response.​countFieldsInSyncinteger(int32)Deprecated

(Deprecated - will always return 0) The number of fields in sync

response.​countLocationsNeedsReviewinteger(int32)Deprecated

The number of locations which are in needs review.

response.​directoriesMissingConnectArray of stringsuniqueDeprecated

The list of DirectoryType missing connection

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

Get Managers Count

Request

Get the Managers Count

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique id for the location

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/dashboard/managers-count/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved location managers count

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

Location Managers Count Model

response.​managersCountinteger(int32)

The number of managers managing the location

Response
No content

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

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

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

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