Skip to content
API Reference/
/
Get Insights Data

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

Get Insights Export Data with threshold

Request

Gets all insights data for the locations. When the request takes too much time, the user will receive the link to the file in an email.

Security
X-API-KEY or Authorization
Query
businessIdsArray of integers(int64)

Filter export data by these businessIds

locationIdsArray of integers(int64)

Filter export data by these locationIds

textFilterstring

Filter export data by this query. It is applied across these location properties: name, street, streetNo, zip, city, country, identifier, labels

startDatestring(date)

Filter export data from this date

endDatestring(date)

Filter export data until this date

curl -i -X GET \
  'https://uberall.com/api/dashboard/export-insights-data-with-threshold?businessIds=0&locationIds=0&textFilter=string&startDate=2019-08-24&endDate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully exported insights data with threshold

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

Dashboard Export Insights Data Response Model

response.​fileUrlstring

The download link. Only available when status is FINISHED.

response.​statusstring

One out of: EMAIL, FINISHED, FAILED EMAIL means the export will be send to the users email. FINISHED means the export is available at the given fileUrl. FAILED means that something went wrong.

Enum"EMAIL""FINISHED""FAILED"
Response
No content

Get Insights Data

Request

Get Insights Data

Security
X-API-KEY or Authorization
Query
businessIdsArray of integers(int64)

The ids of the businesses you want insights data for

locationIdsArray of integers(int64)

The ids of the locations you want insights data for

textFilterstring

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

Example: textFilter=Berlin
typestringrequired

The directory you want insights for. Can be GOOGLE, FACEBOOK, BING or YELP_API

startDatestring(date)

The start date YYYY-MM-DD

endDatestring(date)

The end date YYYY-MM-DD

groupstring

How to group the results, one of: HOUR (only for ACTIONS-PHONE), DAY, WEEK, MONTH, YEAR

metricsArray of strings

The types of metrics you want to get

Items Enum"QUERIES_CHAIN""QUERIES_DIRECT""QUERIES_INDIRECT""VIEWS_MAPS""VIEWS_SEARCH""ACTIONS_WEBSITE""ACTIONS_PHONE""ACTIONS_DRIVING_DIRECTIONS""PHOTOS_VIEWS_MERCHANT""PHOTOS_COUNT_MERCHANT"
curl -i -X GET \
  'https://uberall.com/api/dashboard/insights-data?businessIds=0&locationIds=0&textFilter=Berlin&type=string&startDate=2019-08-24&endDate=2019-08-24&group=string&metrics=QUERIES_CHAIN' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved insights data

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.​metricsArray of objects

List of metrics

Example: [{"name":"ACTIONS_WEBSITE","data":[{"period":"2025-04-01","count":683},{"period":"2025-04-02","count":658}]},{"name":"ACTIONS_PHONE","data":[{"period":"2025-04-01","count":840},{"period":"2025-04-02","count":886}]},{"name":"ACTIONS_DRIVING_DIRECTIONS","data":[{"period":"2025-04-01","count":11097},{"period":"2025-04-02","count":11332}]},{"name":"BUSINESS_IMPRESSIONS_DESKTOP_MAPS","data":[{"period":"2025-04-01","count":8436},{"period":"2025-04-02","count":8248}]},{"name":"BUSINESS_IMPRESSIONS_MOBILE_MAPS","data":[{"period":"2025-04-01","count":131141},{"period":"2025-04-02","count":133253}]},{"name":"BUSINESS_CONVERSATIONS","data":[]},{"name":"BUSINESS_BOOKINGS","data":[]}]
response.​matchedLocationsCountinteger(int32)

The number of locations matching the filter which the insights are returned for

Response
No content

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
X-API-KEY or Authorization
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://uberall.com/api/dashboard/insights-data/warnings?businessIds=0&locationIds=0&textFilter=Berlin&type=string&max=0&offset=0' \
  -H 'X-API-KEY: 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.

response.​totalItemsCountinteger(int32)

Used for pagination. Total number of results of the request

response.​maxinteger(int32)

Used for pagination. Maximum number of results per page

response.​offsetinteger(int32)

Offset used for pagination. Default: 0

response.​connectedLocationsArray of objects

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

response.​notConnectedLocationsArray of objects

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

Response
No content

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

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