Skip to content
API Reference
/
Dashboard
/
Get Profile Completeness

Uberall API (20250708)

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

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 Next Best Actions

Request

Get the Next Best Actions recommended to the current user

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

curl -i -X GET \
  'https://uberall.com/api/dashboard/next-best-actions/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved next best actions

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

LocationTask Model

response.​typestring

The type of the task. The value could be on of [LISTING_FACEBOOK_CONNECTION_MISSING, LISTING_GOOGLE_CONNECTION_MISSING, LISTING_GOOGLE_VERIFICATION_MISSING, LISTING_GOOGLE_PIN_MISSING, LISTING_FIELDS_MISSING, DATAPOINT_UNREPLIED_RECENT, DATAPOINT_UNREAD, DATAPOINT_UNREPLIED_OLD, LOCATION_PROPERTIES_MISSING, LOCATION_ADD_PHOTOS, LOCATION_SOCIAL_POST_MISSING, LOCATION_RICH_DATA_MISSING, LOCATION_ADD_NEW_PHOTOS]

Enum"LOCATION_START_FIRST_SYNC""LOCATION_START_NEW_SYNC""LISTING_FACEBOOK_CONNECTION_MISSING""LISTING_GOOGLE_CONNECTION_MISSING""LISTING_GOOGLE_VERIFICATION_MISSING""LISTING_GOOGLE_PIN_MISSING""LISTING_FIELDS_MISSING""DATAPOINT_UNREPLIED_RECENT""DATAPOINT_UNREAD""DATAPOINT_UNREPLIED_OLD"
response.​propertiesobject

A Map with info related to the specific task

response.​priorityinteger(int32)

The priority of the task to be performed on the location. The value is from 1 to 90 and depends on the Task's type

response.​locationIdinteger(int64)

The location id which the next best action refers to

Response
No content

Get Profile Completeness

Request

Get the profile completeness of the locations managed by the current user

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

The ids of the businesses you want profile completeness for

locationIdsArray of integers(int64)

The ids of the locations you want profile completeness data for

curl -i -X GET \
  'https://uberall.com/api/dashboard/profile-completeness?businessIds=0&locationIds=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved profile completeness

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

ProfileCompleteness Model

response.​missingFieldsArray of stringsunique

The DirectoryFiled missing by the locations

Items Enum"NAME""NAME_DESCRIPTOR""STREET_NO""STREET""STREET_TYPE""ADDRESS_EXTRA""PROVINCE""ZIP""CITY""COUNTRY"
response.​directoriesMissingConnectArray of stringsunique

The list of DirectoryType missing connection

Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
response.​averageProfileCompletenessinteger(int32)

The average of the profile completeness across the locations managed by the user

response.​countLocationsMissingDatainteger(int32)

The number of locations missing required data

response.​locationClassificationCountsobject

The number of locations in each classification

Response
No content

Get Suppressed Duplicates

Request

Get the suppressed duplicates info

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

The ids of the businesses you want suppressed duplicates for

locationIdsArray of integers(int64)

The ids of the locations you want suppressed duplicates data for

typestring

The directory you want suppressed duplicates data for

startDatestring(date)

The start date YYYY-MM-DD

endDatestring(date)

The end date YYYY-MM-DD

curl -i -X GET \
  'https://uberall.com/api/dashboard/suppressed-duplicates?businessIds=0&locationIds=0&type=string&startDate=2019-08-24&endDate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved suppressed duplicates

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

SuppressedDuplicates Model

response.​countByDirectoryArray of objects(CountByDirectoryDetails)

A Map with the number of suppressed duplicates divided by DirectoryType

response.​totalCountinteger(int32)

The total number of suppressed duplicates

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