uberall
uberall
uberall API

uberall API Object Model

Before diving into the complete list of objects returned and used by the API below, it is generally useful to read our Overview to understand high-level concepts and use cases.

ActionsDataMultiLocation
distribution
Distribution
InsightsBenchmarkDistribution
total
Total
Float
type
Type (ACTIONS_PHONE, ACTIONS_WEBSITE, ACTIONS_DRIVING_DIRECTIONS)
String
ActionsDataSingleLocation
difference
Difference
Float
total
Total
Float
type
Type (ACTIONS_PHONE, ACTIONS_WEBSITE, ACTIONS_DRIVING_DIRECTIONS)
String
AdsPerformanceHomepageResponse
conversionRate
Conversion rate (clicks/impressions) for campaigns
float
pricePerInteraction
Price per interaction (budget/clicks)
float
totalAds
Total number of ad campaigns running in the last 30 days
int
AttributeWrapper
displayName
The attribute's name in the required language.
String
externalId
The google attribute id
String
groupDisplayName
Attribute group name
String
value
The value of the attribute. The value depends on the valueType.
BOOL: "true" or "false"
Single URL:"http://uberall.com"
Multiple URLs: ["http://uberall.com", "https://menuari2.com"]
ENUM:"supportedValue1" or "supportedValue2"
REPEATED_ENUM:"supportedValue1,supportedValue2"
String
valueMetadata
List of possible values.
[UNDEFINED,...]
valueType
The attribute type. e.g. BOOL, URL, ENUM, REPEATED_ENUM
GoogleAttributeType
Attribution
height
Height (in px) of the attribution logo
Integer
logoUrl
Required - URL pointing to the attribution logo
String
name
Required - Name of the attribution
String
url
Required - URL the attribution should point to
String
width
Width (in px) of the attribution logo
Integer
AverageRatingMultiLocation
distribution
Benchmark distribution
BenchmarkDistribution
total
Average rating
Float
AverageRatingSingleLocation
benchmarkValue
Local benchmark average rating
Float
total
Average rating
Float
BasicListing
addressDisplay
If set to false the address will not be published on the directories, this is useful for businesses that don't have customers come to them ( e.g. a plumber )
Boolean
addressDisplayStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
addressExtra
An address extra: e.g. building, floor...
String
addressExtraStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
attributes
The location's Google attributes
[Object,...]
attributesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING
FieldStatus
attribution
Attribution logo and url for data source
Attribution
attributionStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
brands
A list of brands available at the location
[String,...]
brandsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
categories
Required - A list of category IDs describing the location
[Object,...]
categoriesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
cellphone
A contact mobile phone number
String
cellphoneStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
city
City
String
cityStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
claimStatus
Claim status of the listing. One of CLAIMABLE, NOT_CLAIMABLE, CLAIMED_BY_US, CLAIMED_BY_OTHERS, CLAIMING_IN_PROGRESS, UNKNOWN
ListingClaimStatus
contentLists
Content lists shown on the listing
[ContentList,...]
contentListsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
country
Country. One of AT, CH, DE, ES, UK, FR, IT, NL
Country
countryStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
dateCreated
The date and time the listing was created in our database
DateTime
descriptionLong
A long description (up to 1000 characters) for the location
String
descriptionLongStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
descriptionShort
A short description (up to 200 characters) for the location
String
descriptionShortStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
directoryType
The directory where this listing appears
DirectoryType
doctorCategories
A list of category IDs for Doctor.com directory
[UNDEFINED,...]
doctorCategoriesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
email
A contact email for the location
String
emailStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
fax
The location fax number
String
faxStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
flowStatus
The status of the current listing. One of SUBMISSION_NEEDED, WAITING_USER_ACTION, WAITING_DIRECTORY_ACTION, ALL_INFORMATION_SUBMITTED, NO_ACTION_NEEDED, NOT_SUPPORTED, INACTIVE, NEEDS_REVIEW, MANUALLY_DEACTIVATED, REMOVAL_REVIEW_NEEDED, REMOVAL_NEEDED, REMOVAL_SUBMITTED, REMOVED, DONT_REMOVE
ListingFlowStatus
imprint
The location's imprint
String
imprintStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING
FieldStatus
keywords
Keywords describing the locations activity
[String,...]
keywordsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
languages
Languages spoken at the location
[String,...]
languagesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
lat
The latitude of the listing
Double
latStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
legalIdent
A legal identifier of the location. SIREN number in France
String
legalIdentStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
listingId
The listing id in the directory's database
String
listingUrl
The listing url on the directory's website
String
lng
The longitude of the listing
Double
lngStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
moreHours
The location's additional service hours, such as delivery, pickup, happy hours etc. Submitted to Google.
[MoreHours,...]
moreHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
name
The location's name used for this listing
String
nameDescriptor
The location's name descriptor (submitted to Facebook).
String
nameDescriptorStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
nameStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
npi
The National Provider Identifier (NPI) is a Health Insurance Portability and Accountability Act (HIPAA) Administrative Simplification Standard. The NPI is a unique identification number for covered health care providers.
String
npiStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
openingDate
The original opening date of the business
LocalDate
openingDateStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
openingHours
The location's opening hours: e.g. 
[ { 
    "dayOfWeek": 1,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00"
  }, 
  {
    "dayOfWeek": 2,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00",
    "from2": "13:00",
    "to2": "21:00"
  },
  {
    "dayOfWeek": 3,
    "closed": true
  }
]
Please note that having more than 2 time periods for each day is not possible.
[OpeningHours,...]
openingHoursNotes
Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters
String
openingHoursNotesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
openingHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
paymentOptions
Payment options available at the location
[String,...]
paymentOptionsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
phone
The location's contact phone number
String
phoneStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
photos
Boolean indicating whether or not the listing has photos
Boolean
photosStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
province
Province. Only send when not blank
String
provinceStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
serviceAreas
Service areas available on the location.
[ServiceArea,...]
serviceAreasStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
services
Services offered at the location. Do not use if Content Collections is enabled. Instead use the Service Item and Collection endpoints
[String,...]
servicesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
socialPost
Social Post
SocialPost
socialPostStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
socialProfiles
Social profiles of the location
[SocialProfile,...]
socialProfilesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
specialOpeningHours
The location's special opening hours: e.g. 
[ { 
    "date": "2017-06-29",
    "closed": true
  }, 
  {
    "date": "2017-06-30",
    "from1": "11:00",
    "to1": "14:00",
    "from2": "16:00",
    "to2": "20:00"
  }
]
Please note that having more than 2 time periods for each day is not possible.
[SpecialOpeningHours,...]
specialOpeningHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
street
The location's street address
String
streetAndNo
A localized combination of street and streetNo
String
streetAndNoStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
streetNo
The location's street number
String
streetNoStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
streetStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
streetType
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
StreetType
streetTypeStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
syncStatus
The sync status of the listing. One of: IN_SYNC (location found on remote directory and in sync with reference data), NOT_IN_SYNC (location found on remote directory but differs from reference data), NOT_FOUND (location not found (yet) on remote directory), TECHNICAL_PROBLEMS (temporary problems when connecting with the directory), NOT_SUPPORTED (if the location is incompatible with the directory or if we cannot search on that directory), NO_ONLINE_LISTING (for the types where there is no listing that can be checked online, e.g. GARMIN), LINK_ONLY (for the types where we can only link a listing by not update it)
ListingSyncStatus
taxNumber
The tax number of the location. CIF/NIF in Spain
String
taxNumberStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
videos
A list of videos about the location
[Video,...]
videosStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
website
A valid url for the location's website (use UTMs to add tracking)
String
websiteStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
zip
Zip code
String
zipStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
FieldStatus
BenchmarkDistribution
aboveBenchmark
Location count performing better than local benchmark
Integer
belowBenchmark
Location count performing worse than local benchmark
Integer
BrandDataPoint
actionDate
The date when the review/photo/... was published in the online directory
DateTime
author
Username of the datapoints author
String
authorImage
Author profile picture url
String
countComments
Number of comments to this item.
Integer
countLikes
Number of likes to this item
Integer
data
Content of the datapoint (text of the review, url of the photo, count of checkins...)
String
dateCreated
The date the datapoint was found
DateTime
directLink
A link to the online profile
String
directoryType
Online directory reference name
DirectoryType
flagged
Whether the datapoint has been flagged. The exact nature of the flagging depends on the directory, but can be e.g. "Report as SPAM"
boolean
lastUpdated
Date of last update
DateTime
liked
Whether this datapoint has been liked or not
boolean
rating
Rating given by the user. Float value, max: 5.
Float
repliedByOwner
True if the owner of the business has replied
Boolean
secondaryData
Additional info about the datapoint (eg. text content on instagram pictures)
String
threadActionDate
The date of the last interaction in that thread. When a review receives a new comment, the parent will update.
DateTime
type
Datapoint Type. Values: [PHOTO, REVIEW, CHECKIN, CONVERSATION, QUESTION]
DataPointType
Business
addressLine2
An address extra: e.g. building, floor...
String
businessSyncable
True if the business is allowed to start a sync. Only relevant for Businesses with more than 10 locations.
Boolean
city
City of the business
String
country
Country of the business
Country
countryPrices
List of country specific prices
[PricePerCountry,...]
customFields
Custom fields to enter additional information on location's for this business
[String,...]
dateCreated
The date and time the business was created in uberall database
DateTime
dateExpiration
The date the businesss contract expires
DateTime
effectiveDate
Date when the business automatically changes its product plan to the new product plan (defined by nextProductPlanId)
DateTime
id
The uberall unique id for the business
Long
identifier
The business identifier based on your internal identification system
String
name
The businesss name
String
nextProductPlanId
ID of the next product plan applied for the business on the defined effectiveDate
Long
numOfLocations
Number of active locations
Integer
phone
Businesss phone number
String
productPlan
The chosen product plan
ProductPlan
province
Province. Only send when not blank
String
status
Businesss status
BusinessStatus
streetAndNo
Address of the business
String
type
Business type. One of SMB or ENTERPRISE
Type
zip
Zipcode of the business
String
BusinessStatistics
count
Total number of businesses
int
countActive
Number of active businesses
int
countWithLocations
Number of businesses with at least one location
int
countWithoutLocations
Number of businesses without any locations
int
CallTrackingNumber
number
The call tracking number for the select directory -- must be different than the location's primary phone number.
String
type
Google, Facebook, or Bing
DirectoryType
CardsHomepageResponse
cards
Cards grouped by Pillar. Rotates per user. 
      "STAND_OUT": [
        "ads",
        "listings",
        "google-impressions",
        "google-indirect-search-queries",
        "google-discovery-search-rank",
        "google-direct-search-queries",
        "google-direct-search-rank"
      ],
      "ATTRACT": [
        "profile-completeness",
        "google-conversions",
        "google-photos",
        "google-conversions-lowest",
        "interactions",
        "storelocator",
        "google-conversions-highest"
      ],
      "DELIGHT": [
        "average-rating",
        "rating-split",
        "reply-rate",
        "reply-rate-split",
        "facebook-posts",
        "review-sentiment"
      ]
Map
Category
id
The uberall unique id for the category
Long
name
The category description
String
parent
The parent category
Category
selectable
Boolean indicating whether the category can be used
boolean
ConflictingRuleResponse
id
id of conflicting Auto Response Rule
String
name
Name of conflicting Auto Response Rule
String
ContentCollection
contentLists
Mandatory - Sections within the content collections
[ContentList,...]
cuisineType
Only applicable to Menu content collections - indicates the cuisine the restaurant serves
CuisineType
description
A description of the collection
String
identifier
Mandatory - A unique identifier for the collection
String
locationIds
Location Ids that should be associated with this collection
[Long,...]
name
Mandatory - Name of the content collection
String
type
Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM
ContentListType
url
Applicable to Menu collections only - url to the brand webpage menu
String
ContentList
dateCreated
The date the content list was created
DateTime
description
A description of the content list (section)
String
itemIds
The list of item ids that should be included within this section of the Content Collection
[Long,...]
lastUpdated
The date the content list was last updated
DateTime
title
The name of the content list: e.g. 'Lunch Menu'
String
translations
Language translations for the section title of a content collection
Map
type
The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or CUSTOM. The type cannot be updated after creation.
ContentListType
ConversationCount
count
Count of conversations (via the Conversations product) in the last 30 days
Integer
directoryType
DirectoryType (Google, Facebook)
DirectoryType
ConversionsInsightsMultiLocation
distribution
Distribution
InsightsBenchmarkDistribution
highest
Highest
ActionsDataMultiLocation
lowest
Lowest
ActionsDataMultiLocation
total
Total
Float
ConversionsInsightsSingleLocation
difference
Difference
Float
highest
Highest
ActionsDataSingleLocation
lowest
Lowest
ActionsDataSingleLocation
total
Total
Float
CurrentPreviousValue
current
The value for the current period
Number
previous
The value for the previous period
Number
CustomItem
category
optional, a category name, e.g. 'Coffee'
String
currency
optional, indicating the currency for price and priceMax in ISO-4217, e.g. EUR
Currency
description
Description
String
id
The uberall unique id for the custom item
Long
identifier
Unique Identifier
String
image
Image url for a custom item
Image
listName
Name of the section this item belongs to (e.g. "Weekly menu")
String
price
optional, the price of the custom, e.g. 1500 ( i.e. 15,00 EUR )
Integer
priceMax
optional, indicating there is a price range, e.g. 2500 ( i.e. 25,00 EUR )
Integer
title
Required - mandatory, the custom name, e.g. 'Strong Coffee'
String
unit
optional, indicating the unit of measure, e.g. 'per kg'
String
url
optional, a url related to the custom item
String
video
optional, a video about the custom
Video
CustomerFeedback
averageRating
Average rating obtained
Float
countByRating
Average count by rating
[Map,...]
interactionCount
The number of review and photos
Integer
matchedLocationsCount
The number of locations matching the given textFilter query
Integer
ratingCount
The total count of rating
Integer
repliedCount
The count of replied reviews
Integer
unreadInteractionCount
The number of reviews and photos unread
Integer
unreadInteractions
The reviews and photos unread
[DataPoint,...]
CustomerFeedbackByPeriod
averageRatingByPeriod
The average ratings of the incoming reviews in the given time periods of the total time span.
[TimeSeriesSegment,...]
interactionCountByPeriod
The number of reviews and photos unread by period
[Map,...]
matchedLocationsCount
The number of locations matching the given textFilter query
Integer
totalRatingCount
The total number of reviews with rating in the given time span.
Integer
CustomerFeedbackKeyword
aggregatedWords
Contains the list of similar words that have been aggregated to this CustomerFeedbackKeyword object
[String,...]
keyword
The actual Keyword
String
percentage
How many documents contained the keyword at least once
CurrentPreviousValue
rating
The average rating of all Reviews that contained this keyword at least once
CurrentPreviousValue
ratingSum
uberDoc.object.CustomerFeedbackKeyword.ratingSum.description
CurrentPreviousValue
CustomerFeedbackKeywords
keywords
The list of keywords
[CustomerFeedbackKeyword,...]
totalFeedbacksAnalyzed
The total number of Feedbacks that have been analyzed.
Integer
CustomerFeedbackKeywordsHomepageResponse
negative
Three most frequent keywords used in negative ratings in the last 30 days
[String,...]
positive
Three most frequent keywords used in positive ratings in the last 30 days
[String,...]
totalReviews
Total amount of reviews considered for the keywords in the last 30 days
Integer
CustomerFeedbackMultiLocationHomepageResponse
averageRating
Average rating
AverageRatingMultiLocation
replyRate
Reviews reply rate
ReplyRateMultiLocation
CustomerFeedbackSingleLocationHomepageResponse
averageRating
Average rating
AverageRatingSingleLocation
replyRate
Reviews reply rate
ReplyRateSingleLocation
DashboardExportData
end
End date of export
Date
group
A time grouping parameter among HOUR, DAY, WEEK, MONTH, YEAR
Group
language
Language of a generated PDF report (e.g. 'de', 'fr', 'en')
String
locationIds
A list of location IDs for which to generate a report
[Long,...]
salesPartnerCountry
Country of the SalesPartner
String
start
Start date of export
Date
status
Current status of the export process (e.g. 'FINISHED', 'SCHEDULED', 'FAILED')
ExportStatus
token
Token of the export job
String
whitelabelIdentifier
Whitelabel identifier which will be used in the outline of the PDF report
String
DashboardExportInsightsDataResponse
fileUrl
The download link. Only available when status is FINISHED.
String
status
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.
Status
DashboardLocation
businessName
Name of the business
String
DataPoint
actionDate
The date when the review/photo/... was published in the online directory
DateTime
author
Username of the datapoints author
String
authorImage
Author profile picture url
String
comments
The list of comments of a Datapoint. Populated in the get, reply, approve and reject datapoint calls.
[DataPoint,...]
countComments
Number of comments to this item.
Integer
countLikes
Number of likes to this item
Integer
data
Content of the datapoint (text of the review, url of the photo, count of checkins...)
String
dateCreated
The date the datapoint was found
DateTime
directLink
A link to the online profile
String
directoryType
Online directory reference name
DirectoryType
flagged
Whether the datapoint has been flagged. The exact nature of the flagging depends on the directory, but can be e.g. "Report as SPAM"
boolean
lastUpdated
Date of last update
DateTime
liked
Whether this datapoint has been liked or not
boolean
locationId
The Location ID associated with this datapoint
Long
rating
Rating given by the user. Float value, max: 5.
Float
repliedByOwner
True if the owner of the business has replied
Boolean
secondaryData
Additional info about the datapoint (eg. text content on instagram pictures)
String
threadActionDate
The date of the last interaction in that thread. When a review receives a new comment, the parent will update.
DateTime
type
Datapoint Type. Values: [PHOTO, REVIEW, CHECKIN, CONVERSATION, QUESTION]
DataPointType
DataPointFilter
businessIds
The list of businesses IDs for which the dataPoints should be filtered
[Long,...]
countries
The list of countries for which the dataPoints should be filtered
[Country,...]
dataPointTypes
The list of data point types (REVIEW or PHOTO) for which the dataPoints should be filtered
[DataPointType,...]
dateEnd
The maximum date for which the dataPoints should be filtered
DateTime
dateStart
The minimum date for which the dataPoints should be filtered
DateTime
directories
The list of directories for which the dataPoints should be filtered
[DirectoryType,...]
hasReply
Flag to set when only datapoints with a reply should be shown
Boolean
hasText
Flag to set when only datapoints with text should be shown
Boolean
isRead
Flag to set when only datapoints should be shown that the current user already read
Boolean
labels
The list of labels for which the dataPoints should be filtered
[String,...]
name
Required - The filter name
String
ownerId
The id of the user that owns the filter
Long
ownerName
The name of the user that owns the filter
String
query
Any combination of words that should be checked in the dataPoints text, reply messages and author
String
ratings
The list of ratings (1, 2, 3, 4 or 5) for which the dataPoints should be filtered
[Integer,...]
salesPartnerId
The sales partner to which the filter belongs
Long
shared
Defines if the filter is shared or not
boolean
subscriberIds
The list of user's ids that are subscribed to the filter
[Long,...]
timeSpan
uberDoc.object.DataPointFilter.timeSpan.description
DataPointFilterTimeSpan
DataPointTimeSeriesResponse
timeseries
A list of TimeSeriesValues
[DataPointTimeSeriesValue,...]
DataPointTimeSeriesValue
datapoints
A map with the count of datapoints, for each type, for the specific date
Map
date
The Date
String
DatapointStatisticsResponse
averageRating
Average rating obtained
Float
checkinCount
Number of checkins
Integer
directories
Breakdown by directory
Map
pendingApprovalCount
Number of replies pending approval
Integer
photoCount
Number of photos
Integer
postCount
uberDoc.object.DatapointStatisticsResponse.postCount.description
Integer
questionCount
Number of questions
Integer
ratingCount
Number of ratings
Integer
reviewCount
Number of reviews
Integer
totalCount
Total number of datapoints
Integer
unreadCount
Number of unread datapoints
Integer
DirectoryPageResponse
id
The Uberall unique id for the directory page
Long
level
uberDoc.object.DirectoryPageResponse.level.description
Level
name
The Directory Page name on the directory
String
type
The Directory Page type [BUSINESS_PAGE, DIRECTORY_PAGE]
DirectoryType
DoctorComData
credentials
Medical professional's credentials (max character limit: 25)
String
doctorCategories
Doctor.com categories
[Long,...]
hospitalAffiliations
Hospital affiliations
String
insurancesAccepted
Types of insurance accepted by the provider
String
isProvider
Defines if the listing is for a provider or not
boolean
npi
National Provider Id (NPI)
String
practiceName
Name of the medical practice
String
providerFirstname
Medical professional's first name
String
providerMiddlename
Medical professional's middle name
String
providerSurname
Medical professional's surname
String
providerTitle
Medical professional's title
String
university
The University where the provider received their degree
String
EmailSettings
emailType
Type of email. Currently, the types of email supported are: DIGEST, ACTIVATION, START_VERIFICATION_GOOGLE, FINISH_VERIFICATION_GOOGLE, UNREAD_REVIEW_NOTIFICATION, PENDING_APPROVAL_REPLY_NOTIFICATION.
EmailType
frequency
Frequency of the emailType. The available frequencies by email type are: DIGEST: WEEKLY, MONTHLY or NEVER; ACTIVATION: ALWAYS or NEVER; START_VERIFICATION_GOOGLE: ALWAYS or NEVER; FINISH_VERIFICATION_GOOGLE: ALWAYS or NEVER; UNREAD_REVIEW_NOTIFICATION: ALWAYS or NEVER; PENDING_APPROVAL_REPLY_NOTIFICATION: DAILY, ALWAYS or NEVER.
Frequency
Event
description
The description of the event: e.g. "Watch a lot of awesome movies."
String
identifier
Unique Identifier for the Event
String
listName
Name of the Event
String
timeEnd
Required - The date the event ends
DateTime
timeStart
Required - The date the event starts
DateTime
title
Required - The title of the event
String
url
The url of the page with more details about the event
String
video
A video to promote the event
Video
FeaturesResponse
defaultFeatures
A list with the default features for the user.
[Feature,...]
locations
Get user features partitioned by location.
[LocationFeatureResponse,...]
FeedItem
date
Action date of the feed item
DateTime
properties
A Map containing the specific information related to the Feed
Map
type
The Feed item type, one of [INTERACTION, TRACKING, LOCATION_EVENT, LISTING_EVENT]
Type
FiltersResponse
businesses
List of business ids and names
[Map,...]
countries
List of countriy names
[Country,...]
directories
List of directory names
[DirectoryType,...]
labels
List of labels
[String,...]
GoogleSearchResultsMultiLocation
firstPageLocationRatio
Ratio of locations appearing on the first page of search results (top 10 results)
Float
top3LocationRatio
Ratio of locations appearing in the top 3 results of search
Float
GoogleSearchResultsSingleLocation
firstPage
Does the location appear on the first page of search results (top 10 results)
boolean
top3
Does the location appear within the top 3 results of search
boolean
HeaderMultiLocationHomepageResponse
attractScore
Score for ATTRACT Pillar
Double
categories
List of most frequently used categories for all locations
[String,...]
categoriesCount
uberDoc.object.HeaderMultiLocationHomepageResponse.categoriesCount.description
Integer
citiesCount
Count of different cities for all locations
Integer
countriesCount
Count of different countries for all locations
Integer
delightScore
Score for DELIGHT Pillar
Double
globalScore
'Near Me' 360 score
Integer
locationCount
Count of all locations
Integer
profileType
Profile type. Possible values: UC-H (low Stand Out, Attract and Delight scores), UC-V (high Stand Out score, low Attract and Delight scores), UR-H (low Stand Out and Attract score, high Delight score), UR-V (high Stand Out and Delight scores, low Attract score), AC-H (low Stand Out and Delight score, high Attract score), AC-V (high Stand Out and Attract scores, low Delight score)
String
standOutScore
Score for STAND_OUT Pillar
Double
HeaderSingleLocationHomepageResponse
attractScore
Score for ATTRACT Pillar
Double
delightScore
Score for DELIGHT Pillar
Double
globalScore
'Near Me' 360 score
Integer
profileType
Profile type. Possible values: UC-H (low Stand Out, Attract and Delight scores), UC-V (high Stand Out score, low Attract and Delight scores), UR-H (low Stand Out and Attract score, high Delight score), UR-V (high Stand Out and Delight scores, low Attract score), AC-H (low Stand Out and Delight score, high Attract score), AC-V (high Stand Out and Attract scores, low Delight score)
String
standOutScore
Score for STAND_OUT Pillar
Double
Image
description
Description of the image
String
id
The uberall unique id for the image
Long
type
Required - The image type, one of [LOGO, MAIN, IMAGE]
Type
uid
Required - user identifier of the image
String
url
Required - Image url
String
ImpressionsInsightsMultiLocation
distribution
Distribution
InsightsBenchmarkDistribution
total
Total
Integer
ImpressionsInsightsSingleLocation
difference
Difference
Float
total
Total
Integer
InboxResponse
count
The total number of datapoints
Long
dataPoints
A list of datapoints (reviews, photos, check-ins ...)
[DataPoint,...]
ignoredLocations
A list of locations where datapoints are not tracked
[Long,...]
page
The page number for pagination
Integer
pageSize
The number of datapoints to show on each page
Integer
status
Status indicating whether Inbox is active for the current location. One of ACTIVE INACTIVE
String
Insights
matchedLocationsCount
The number of locations matching the filter which the insights are returned for
Integer
metrics
A Map containing the metrics divided by DirectoryType
Map
InsightsBenchmarkDistribution
aboveBenchmark
Location count performing better than local benchmark
Integer
belowBenchmark
Location count performing worse than local benchmark
Integer
InsightsDataMultiLocationHomepageResponse
conversions
Conversions data on Google
ConversionsInsightsMultiLocation
impressions
Impressions count on Google
ImpressionsInsightsMultiLocation
totalLocations
Location count
Integer
InsightsDataSingleLocationHomepageResponse
conversions
Conversions data on Google
ConversionsInsightsSingleLocation
impressions
Impressions count on Google
ImpressionsInsightsSingleLocation
InteractionsHomepageResponse
conversations
Conversations
[ConversationCount,...]
googleQuestionsCount
Count of user-generated questions on Google in the last 30 days
Integer
Label
adminOnly
Permission on label, whether it can be used by admins or everyone.
boolean
name
Label name as String.
String
Listing
accountInfo
A map consisting of the name and pageId of the connected account if the listing is either Google or Facebook.
Map
claimStatus
Claim status of the listing.
ListingClaimStatus
connectStatus
Connect status of the listing.
ListingConnectStatus
data
A map containing optional information about the listing, e.g. latestVisibilityIndex.
Map
id
The id of the listing.
Long
lastChecked
The last time the listing was sync-checked.
DateTime
lastSuccessfulUpdate
The last time the listing was successfully updated.
DateTime
listingId
The listing's id in the directory's database.
String
listingUrl
The listing's URL on the directory's website.
String
mandatoryFields
Mandatory fields for the specific Directory that are not set yet
[DirectoryField,...]
status
The listing's status.
ListingStatus
syncStatus
The listing's sync status.
ListingSyncStatus
type
The directory where this listing appears.
DirectoryType
typeName
The directory's name in the language of the current locale.
String
ListingHealth
countFieldsInSync
(Deprecated - will always return 0) The number of fields in sync
Integer
countListingsActionRequired
uberDoc.object.ListingHealth.countListingsActionRequired.description
Integer
countListingsBeingUpdated
The number of listings which are in the process of being updated
Integer
countListingsInSync
Output only. The number of listings in sync
Integer
countListingsLinked
uberDoc.object.ListingHealth.countListingsLinked.description
Integer
countListingsSubmitted
uberDoc.object.ListingHealth.countListingsSubmitted.description
Integer
countLocationsNeedsReview
The number of locations which are in needs review.
Integer
countLocationsRequireSync
The number of locations which require to be syncronized
Integer
directoriesMissingConnect
The list of DirectoryType missing connection
[DirectoryType,...]
ListingHealthMultiLocationHomepageResponse
facebookConnectedLocations
Count of locations connected on Facebook
Integer
googleVerifiedLocations
Count of locations connected and verified on Google Business Profile
Integer
totalLocations
Total locations
int
ListingHealthSingleLocationHomepageResponse
onlineListings
Count of listings online for the location
int
totalListings
Total listings
int
ListingsDetailsResponse
Location
activeDirectoriesCount
Output only. Number of active directories
Integer
activeListingsCount
Output only. Number of active listings
Integer
addressDisplay
Indicates if the address should be displayed or hidden
Boolean
addressExtra
An address extra: e.g. building, floor...
String
attributes
Google attributes
[AttributeWrapper,...]
autoSync
When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.
boolean
brands
The brands offered by the location to its customers
[String,...]
businessId
ID of the business this location is linked to. Mandatory when creating a location. Sending a different ID than the current businessId when updating will lead to changing the business. This is only possible in case all connected accounts (Facebook, Google, …) are compatible.
Integer
callTrackingNumbers
Add call tracking numbers for distribution to Google, Facebook, and Bing. The call tracking numbers must be different from the location's primary phone number
[CallTrackingNumber,...]
categories
Required to start location sync - A list of category IDs describing the location
[Category,...]
cellphone
A contact mobile phone number
String
city
Required - City
String
cleansingComment
Cleansing comment by user, set only when cleansingStatus is INVALID_DATA. Possible Values (ADDRESS_DETAILS_VERIFIED, NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)
CleansingComment
cleansingInvalidDataReason
Output only. Invalid Cleansing Reason (eg. INCOMPLETE_ADDRESS,ADDRESS_ IS_PO_BOX,ADDRESS_ DOES_NOT_EXIST, LOCATION_IS_CLOSED, INFORMATION_IS_WRONG, LOCATION_IS_MOVED, NON_LATIN_CHARACTERS_ADDRESS, OTHER). Guide on how to fix invalid data issues - http://ubr.al/fix_invalid_data
String
cleansingStatus
Output only. Current cleansing status for the location. Possible values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA
CleansingStatus
contentLists
The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the location
[Integer,...]
country
Required - Country of the location
Country
customFields
User-defined custom fields. A Map of identifying names and corresponding values. example Parameters: 
  "customFields": [
    {
      "name": "foo",
      "value": "bar"
    },
    {
      "name": "baz",
      "value": "qux"
    }
  ]
[Map,...]
dataPoints
Output only. Number of dataPoints (reviews, photos) left by users at this location
Integer
dateCreated
Output only. The date and time the location was created in our database
DateTime
descriptionLong
A long description - up to 1000 characters, all characters must match this regexp: 
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€\^£$]
String
descriptionShort
A short description - up to 200 characters, all characters must match this regexp: 
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€£$]
String
doctorComData
Doctor.com specific data, such as doctorCategories, npi, credentials, university, hospitalAffiliations, insurancesAccepted. Formatted as such: 
"doctorComData":{
   "hospitalAffiliations":"Hospital Research Institute",
   "doctorCategories":[
      227
   ],
   "credentials":"MD, NAME",
   "npi":"1234567",
   "university":"University name"
}
DoctorComData
email
A contact email for the location
String
emailVerification
The locations verification status
VerificationStatus
fax
The location fax number
String
features
Output only. List of features available to the location
[Feature,...]
id
Output only. The uberall unique id for the location
Long
identifier
The location identifier based on your internal identification system
String
imprint
The imprint of the location
String
keywords
Keywords describing the locations activity
[String,...]
labels
Labels grouping similar locations
[Label,...]
languages
The language(s) in which customers can interact with the location's staff
[String,...]
lastSyncStarted
Output only. Date of the last sync for the location
DateTime
lastUpdated
Output only. Date of the last changes made to the location
DateTime
lat
The latitude coordinate of the location
Double
legalIdent
A legal identifier of the location. SIREN number in France
String
listings
Output only. List of this location's online listings together with their sync status
[Listing,...]
listingsBeingUpdated
Output only. Number of listings still being updated
Integer
listingsInSync
Output only. The number of listings in sync
Integer
lng
The longitude coordinate of the location
Double
mainPhoto
The locations main picture
LocationPhoto
missingMandatoryFields
Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]
[DirectoryField,...]
moreHours
The location's additional service hours, such as delivery, pickup, happy hours etc. Submitted to Google. e.g. 
[{
    "type": "ONLINE_SERVICE_HOURS",
    "hours": [{
        "dayOfWeek": 1,
        "from1": "09:00",
        "to1": "18:00"
    }, {
        "dayOfWeek": 2,
        "from1": "09:00",
        "to1": "13:00"
    }]
}, {
    "type": "ACCESS",
    "hours": [{
        "dayOfWeek": 1,
        "from1": "06:00",
        "to1": "20:00"
    }]
}]
[Map,...]
name
Required - The location's name
String
nameDescriptor
An addition to the location's name which gives specific info about the location's address (e.g. Mall level 2 OR Inside Departures). Sent only to FACEBOOK
String
openingDate
The date the location will first open. Must be formatted YYYY-MM-DD
LocalDate
openingHours
The location's opening hours: e.g. 
[ { 
    "dayOfWeek": 1,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00"
  }, 
  {
    "dayOfWeek": 2,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00",
    "from2": "13:00",
    "to2": "21:00"
  },
  {
    "dayOfWeek": 3,
    "closed": true
  }
]
Please note that having more than 2 time periods for each day is not possible.
[OpeningHours,...]
openingHoursNotes
Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters, all characters must match this regexp: 
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&\r\n\t_\*§²`´·"'\+¡¿@]
String
paymentOptions
The payment options accepted at the location (eg. cash, bank transfer, ...)
[String,...]
phone
The location's contact phone number, a valid phone number has to be provided.
String
photos
The location's photos
[LocationPhoto,...]
profileCompleteness
Output only. Number representing completeness of location data, up to 100
Integer
province
Province. Only send when not blank
String
publishedListingsCount
Output only. Number of published listings
Integer
serviceAreas
Service areas available on the location.
[ServiceArea,...]
services
Services offered at the location. Do not use if Content Collections is enabled. Instead use the Service Item and Collection endpoints
[String,...]
socialProfiles
The profiles of the location on social and professional networks (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER, VIMEO, XING, YOUTUBE)
[SocialProfile,...]
specialOpeningHours
The location's special opening hours: e.g. 
[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": 16:00",
"to2": "20:00"
}
]
Please note that having more than 2 time periods for each day is not possible.
[SpecialOpeningHours,...]
status
The status of the location. One of:
  • ACTIVE - will be synced and renewed
  • INACTIVE - will not be synced anymore, claims of listings will be released where possible
  • CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE
  • CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported
LocationStatus
street
Required - The location's street address
String
streetNo
The location's street number
String
streetType
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
StreetType
taxNumber
The tax number of the location. CIF/NIF in Spain
String
timeZone
uberDoc.object.Location.timeZone.description
String
transactionLinks
uberDoc.object.Location.transactionLinks.description
[LocationTransactionLink,...]
updateHistory
Output only. Information which has been updated but not synced yet
Map
utms
UTM parameter to be appended to the location's website. Codes can be sent to Google, Facebook, and Bing.
[UTM,...]
videos
The location's videos
[Video,...]
visibilityIndex
Output only. The location's latest visibility index
Integer
website
A valid url for the location's website (use UTMs to add tracking)
String
zip
Zip code, optional only for some countries.
String
LocationDashboardResponse
location
The location linked to this dashboard
DashboardLocation
stats
Statistics related to the current location
LocationDashboardStatistics
todos
Todos related to the current location
String
LocationDashboardStatistics
activeDirectories
List of active directories
[String,...]
activeDirectoriesCount
Output only. Number of active directories
Integer
activeListingsCount
Output only. Number of active listings
Integer
inactiveDirectories
List of inactive directories
[String,...]
inboxActive
ACTIVE if the inbox feature is included in the plan
String
inboxPhotos
Number of photo datapoints
Integer
inboxReviews
Number of review datapoints
Integer
inboxTotal
Total number of datapoints
Integer
managersCount
Number of users that manage this location
Integer
profileCompleteness
Percentage of profile completeness
Integer
publishedListingsCount
Number of managed online listings
Integer
synced
Number of synced listings
Integer
unfilledFields
Unfilled location fields
[String,...]
visibilityIndex
Latest visibility index
VisibilityIndex
LocationFeatureResponse
businessId
Business the location belongs to.
Long
currentFeatures
The features enabled for the location.
[Feature,...]
id
The id of the location.
Long
limitReached
indicates if location has reached its limit for given set of Features
[Feature,...]
potentialFeatures
Features that are currently not available for this location, but can potentially be enabled.
[Feature,...]
status
Status of the location
LocationStatus
LocationGroup
LocationGroupListResponse
LocationManagersCount
managersCount
The number of managers managing the location
Integer
LocationPhoto
cropHeight
Height of the 16:9 cropped area [LANDSCAPE photo only]
Integer
cropOffsetX
Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
Integer
cropOffsetY
Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
Integer
cropWidth
Width of the 16:9 cropped area [LANDSCAPE photo only]
Integer
dateCreated
The date when the object was created in uberall database
DateTime
description
A description for the photo - max 255 chars
String
identifier
The photo identifier based on your internal identification system
String
lastUpdated
Date of the last changes made to the photo
DateTime
order
Sets the order in which the photos should be shown
Integer
sourceUrl
The URL to the original photo
String
type
Required - One of:
MAIN
LOGO
SQUARED_LOGO
LANDSCAPE - Updates Google Cover Photo
PHOTO
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
LocationPhotoType
url
Required - url of the photo
String
LocationPhotoResponse
cropHeight
Height of the 16:9 cropped area [LANDSCAPE photo only]
Integer
cropOffsetX
Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
Integer
cropOffsetY
Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
Integer
cropWidth
Width of the 16:9 cropped area [LANDSCAPE photo only]
Integer
dateCreated
The date when the object was created in uberall database
DateTime
description
A description for the photo
String
id
The uberall unique id for the photo
Long
identifier
The photo identifier based on your internal identification system
String
isPremium
Identifies whether the photo is or is not a Premium Photo from the Uberall Premium Photo Package
boolean
locationId
The uberall unique id of this photo's location
Long
logo
A boolean indicating whether this photo is the location's logo. Maximum one logo per location
boolean
main
A boolean indicating whether this photo is the location's main photo. Maximum one per location
boolean
publicUrl
A public url for this photo
String
repoKey
File name
String
sourceUrl
The client supplied url for a photo
String
thumbnailUrl
Url for the image thumbnail
String
type
Required - One of:
MAIN
LOGO
SQUARED_LOGO
LANDSCAPE - Updates Google Cover Photo
PHOTO
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
String
LocationProfileCompleteness
completenessPerField
A map that contains for each Classification the fields and a corresponding boolean value if that field is filled or not.
Map
currentClassification
The current classification of the Location - one of REQUIRED, BASIC, ADVANCED, BONUS or COMPLETE
Classification
LocationResponse
location
A complete Location object
Location
suggestionsForFields
Map containing fields and the suggested values from different directories.
[Map,...]
suggestionsForFieldsAvailable
true if any suggetions are available
Boolean
LocationSearchResult
addressDisplay
If set to false, directories are either not given address details or told not to display them. There are few directories where this is not possible, that hence might not receive data at all.
Boolean
addressExtra
An address extra: e.g. building, floor...
String
attributes
The location's Google attributes
[LocationAttribute,...]
autoSync
When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.
Boolean
businessId
The id of the business associated with this location
Long
cancellationDate
The date when the location was cancelled
DateTime
categories
Required - A list of category IDs describing the location
[Category,...]
cellphone
A contact mobile phone number
String
city
City
String
country
Country. One of AT, CH, DE, ES, UK, FR, IT, NL
Country
dateCreated
The date and time the location was created
DateTime
descriptionLong
A long description (up to 1000 characters) for the location
String
descriptionShort
A short description (up to 200 characters) for the location
String
distance
Used for store finder. The distance between the current position and this location
Integer
email
A contact email for the location
String
endDate
The date the location's contract expires
DateTime
fax
The location fax number
String
features
Output only. List of features available to the location
[String,...]
hasFacebook
Boolean indicating whether the location has support Facebook included in its product plan
Boolean
id
The uberall unique id for the location
long
identifier
The location identifier based on your internal identification system
String
imprint
imprint of the location
String
keywords
Keywords describing the locations activity
[String,...]
labels
Labels grouping similar locations
[Label,...]
lastSyncStarted
Output only. Date of the last sync for the location
DateTime
lastUpdated
Output only. Date of the last changes made to the location
DateTime
lat
The latitude coordinate of the location
Double
legalIdent
A legal identifier of the location. SIREN number in France
String
lng
The longitude coordinate of the location
Double
locationSyncable
Boolean indicating whether the location has been updated and can be synced
boolean
name
The location's name
String
openNow
Used for store finder. Boolean indicating whether the location is currently open
Boolean
openingHours
The location's opening hours: e.g. 
[ { 
    "dayOfWeek": 1,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00"
  }, 
  {
    "dayOfWeek": 2,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00",
    "from2": "13:00",
    "to2": "21:00"
  },
  {
    "dayOfWeek": 3,
    "closed": true
  }
]
Please note that having more than 2 time periods for each day is not possible.
[OpeningHours,...]
openingHoursNotes
Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters
String
phone
The location's contact phone number
String
photos
List of Photos
[LocationPhoto,...]
province
Province. Only send when not blank
String
skipFacebookPicturesUpdate
Skip updating photos on Facebook
Boolean
socialPostId
Social Post Id of the location
Long
sortableData
A JSON indicating which parameters can be used when sorting a list of locations including this one
SortableData
specialOpeningHours
The location's special opening hours: e.g. 
[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": "16:00",
"to2": "20:00"
}
]
Please note that having more than 2 time periods for each day is not possible.
[SpecialOpeningHours,...]
status
The status of the location. One of:
  • ACTIVE - will be synced and renewed
  • INACTIVE - will not be synced anymore, claims of listings will be released where possible
  • CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE
  • CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported
LocationStatus
street
The location's street address
String
streetNo
The location's street number
String
streetType
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
StreetType
suggestionsForFieldsAvailable
true if any suggetions are available
Boolean
taxNumber
The tax number of the location. CIF/NIF in Spain
String
website
A valid url for the location's website (use UTMs to add tracking)
String
zip
Zip code
String
LocationStatisticsResponse
count
Total number of locations
Integer
countActive
Number of active locations
Integer
countCancelled
Number of cancelled locations
Integer
countClosed
Number of closed locations
Integer
countInactive
Number of inactive locations
Integer
countSyncNeeded
Number of locations where sync is needed
Integer
countSyncNotStarted
Number of locations where sync has not been started
Integer
countSyncStarted
Number of locations where sync has been started
Integer
suggestionsAvailable
true if any suggetions are available
Boolean
LocationTask
locationId
The location id which the next best action refers to
Long
priority
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
Integer
properties
A Map with info related to the specific task
Map
type
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]
Type
LodgingField
category
uberDoc.object.LodgingField.category.description
String
displayName
uberDoc.object.LodgingField.displayName.description
String
externalId
uberDoc.object.LodgingField.externalId.description
String
LoggingEvent
dateCreated
The date the logging event was created
Long
id
The uberall unique id for the logging event
Long
payload
A JSON containing detailed information about the logging event
Map
source
The id of the object the logging event is about
Long
type
The logging event type. One of LISTING_UPDATE, LISTING_SYNC_CHECK, LISTING_DATAPOINT_CHECK, LISTING_PUBLISHER_UPDATE, LISTING_BLACKLIST, LISTING_REVIEWED, LISTING_STATUS_CHANGE, LISTING_MANUAL, LISTING_SUPPRESS, LISTING_DELETE, LISTING_CANCEL, LISTING_FACEBOOK_PAGE_INVALIDATE, LISTING_FLAGGED, LISTING_LINK_CHANGE, LISTING_REMOVAL_SUPPRESS, LISTING_SUPPRESS_NOT_ALLOWED, LISTING_UPDATE_SPECIAL_OFFER, LISTING_REMOVAL_STATUS_CHECK, LOCATION_BILLING, LOCATION_SYNC_STARTED, LOCATION_PROFILE_CHANGED, LOCATION_SUBSCRIPTION_CHANGED, LOCATION_LISTING_ADDED, LOCATION_VISIBILITY_INDEX_CHANGED, LOCATION_STATUS_CHANGED, LOCATION_PRODUCT_PLAN_CHANGED, LOCATION_NORMALIZATION_STATUS_CHANGED, LOCATION_CREATED, LOCATION_DUPLICATE_LISTING_DETECTION, LOCATION_DUPLICATE_LISTING_CHECK, LOCATION_CHECKOUT, LOCATION_CHECKOUT_FREE, LOCATION_CHECKOUT_UPGRADE, LOCATION_CHECKOUT_SALESPARTNER, USER_PASSWORD_RESET, SALES_PARTNER_SIGNUP, SALES_PARTNER_APPROVAL, SALES_PARTNER_PASSWORD_RESET, SEARCH_DATA_RECHECK_LINK_SHARED, BUSINESS_COMMENT, BUSINESS_INVOICE_CREATED, BUSINESS_INVOICE_RENEWAL_SUCCESS, BUSINESS_INVOICE_RENEWAL_FAIL, BUSINESS_INVOICE_CREATED_FIRST_BASIC, BUSINESS_INVOICE_CREATED_FIRST_PREMIUM, BUSINESS_INVOICE_CREATED_UPGRADE_BASIC, BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM, BUSINESS_INVOICE_CREATED_ANOTHER_BASIC, BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM, BUSINESS_INVOICE_CREATED_RENEWAL, BUSINESS_DIRECTORY_ACCOUNT, BUSINESS_CSV_EXPORT, BUSINESS_UPDATE_PRICE, ADMIN_LOGIN_ALERT
Type
LoginCommand
email
User email (email or userId is required)
String
password
User Password (password or private_key is required)
String
private_key
Private key (password or private_key is required)
String
userId
UserId (email or userId is required)
Long
LoginResponse
access_token
Access Token
String
LogoutResponse
success
True if logout was successful
boolean
MentionsPagesDetails
avatar
uberDoc.object.MentionsPagesDetails.avatar.description
String
id
uberDoc.object.MentionsPagesDetails.id.description
String
link
uberDoc.object.MentionsPagesDetails.link.description
String
name
uberDoc.object.MentionsPagesDetails.name.description
String
NextOpen
closedNow
true if the location is closed now; otherwise false
boolean
date
date when the location will be opened; for example "2018-11-16" (string) (this parameter is used only if closedNow true and neverOpens false)
LocalDate
dayOfWeek
day of week when the location will be opened; format like OpeningHours: 1 for Monday, 2 for Tuesday, etc (this parameter is used only if closedNow true and neverOpens false)
Day
hour
defines at which time at the date "date" the location will be open; for example: "13:00" (this parameter is used only if closedNow true and neverOpens false)
Integer
neverOpens
true if the location will never open again; otherwise false (this parameter is used only if closedNow true)
boolean
OpeningHours
closed
Indicates whether a location is closed on a day.
Boolean
dayOfWeek
Required - The weekday of an opening hours, e.g.: 1 for Monday, 2 for Tuesday, ...
Integer
fromX
A beginning of a period. One or multiple periods are supported per dayOfWeek, e.g.: "from1": "09:00", "from2": "15:00"
String
toX
An end of a period. One or multiple periods are supported per dayOfWeek, e.g.: "to1": "14:30", "to2": "17:00"
String
PagesSearchResponse
after
uberDoc.object.PagesSearchResponse.after.description
String
before
uberDoc.object.PagesSearchResponse.before.description
String
mentions
uberDoc.object.PagesSearchResponse.mentions.description
[MentionsPagesDetails,...]
Person
description
Description for the person: e.g. Responsible for the day-to-day operations of the store
String
id
The uberall unique id for the person
Long
identifier
Unique Identifier for the Person
String
image
Picture of the person
Image
listName
Name of the section this person belongs to
String
name
Required - The person's full name
String
title
The person's title: e.g. Store manager
String
url
A valid url of a page with more details about the person
String
PhotoContainer
description
Description for the social post photo
String
photo
Placeholder to represent photo for a social post which can either be a base64 encoded string or a S3 link for image
Object
redirectUrl
The URL that a user is redirected to when clicking the photo
String
PricePerCountry
country
Country
Country
marketDevelopmentFunds
Market Development Funds (MDF)
int
price
Price for the country in cents: e.g. 1500 for 15 €
int
priceSetup
Setup fee
int
Product
category
A category the product belongs to: e.g. Coffee
String
currency
Currency used for prices in ISO-4217: e.g. EUR, USD, CHF
Currency
description
Description
String
id
The uberall unique id for the product
Long
identifier
Unique Identifier
String
image
A representative image of the product item
Image
listName
Name of the section this item belongs to (e.g. "Weekly menu")
String
price
Price of the product in cents: e.g. 1500 for 15 €
Integer
priceMax
Maximum price if you want to use a price range for the product
Integer
title
Required - The name of the product: e.g. Strong Coffee
String
unit
A unit of measure, e.g. per kg
String
url
A valid page url with more details about the product
String
video
A video about the product
Video
ProductPlan
automationDirectories
List of directories supported by this plan
[DirectoryType,...]
billingPeriod
Period in months for which the location is billed
Integer
countryPrices
List of country specific prices
[PricePerCountry,...]
defaultMarketDevelopmentFunds
Default Market Development Funds
Integer
defaultOriginalPrice
Default Original Price in cent
Integer
defaultPlan
True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.
boolean
defaultPrice
Mandatory if countryPrices is not populated. Define a global price for the Product Plan that gets applied for all countries
Integer
defaultPriceSetup
Set-up price per location in cent
Integer
description
Description of the plan
String
duration
Required - Duration of the Product Plan in months
Integer
features
List of features supported by this plan
[Feature,...]
identifier
The Product Plan identifier based on your internal identification system
String
initialBillingPeriod
Initial Billing Period
Integer
initialDuration
Initial Duration
Integer
name
Required - The name of the product plan
String
status
One among PENDING_APPROVAL, ACTIVE, INACTIVE
ProductPlanStatus
ProductPlanCountryPriceResponse
country
Required - Country
Country
marketDevelopmentFunds
Market Development Funds (MDF)
int
price
Required - Price for the specific Country
Integer
priceSetup
Setup fee
int
ProductPlanResponse
billingPeriod
Cadency with which an invoice is generated for this Product Plan
Integer
countryPrice
Prices per location for each supported country
[ProductPlanCountryPriceResponse,...]
currency
The abbreviation of the currency the product plan is charged in.
String
dateCreated
The date and time the Product Plan was created in our database
DateTime
defaultMarketDevelopmentFunds
Default Market Development Funds
Integer
defaultOriginalPrice
Default Original Price in cent
Integer
defaultPlan
True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.
boolean
defaultPrice
Define a global price for the Product Plan that gets applied for all countries
Integer
defaultPriceSetup
Set-up price per location in cent
Integer
description
Description of the plan
String
duration
Duration of the Product Plan in months
Integer
features
List of features supported by this plan
[Feature,...]
id
The uberall unique id
Long
identifier
The Product Plan identifier based on your internal identification system
String
initialBillingPeriod
Initial Billing Period
Integer
initialDuration
Initial Duration
Integer
lastUpdated
The date and time the Product Plan was last updated
DateTime
name
The name of the product plan
String
salesPartnerId
Sales Partner of the Product Plan
Long
status
One among PENDING_APPROVAL, ACTIVE, INACTIVE
ProductPlanStatus
updatedDirectories
List of directories supported by this plan
[DirectoryType,...]
ProfileCompleteness
averageProfileCompleteness
The average of the profile completeness across the locations managed by the user
Integer
locationClassificationCounts
The number of locations in each classification
Map
ProfileCompletenessMultiLocationHomepageResponse
locationClassificationCounts
LocationClassificationCounts - Map with Classifications and the count of locations for each 
  "REQUIRED": 1,
  "BASIC": 1,
  "ADVANCED": 1,
  "BONUS": 1,
  "COMPLETE": 1
Map
missingDataLocationCount
Count of locations with missing data
Integer
profileCompletenessScore
Profile Completeness Score
Integer
totalLocations
Total locations
Integer
ProfileCompletenessSingleLocationHomepageResponse
currentLevel
Classification (one of REQUIRED, BASIC, ADVANCED, BONUS, COMPLETE)
Classification
profileCompletenessScore
Profile Completeness Score
Integer
ReplyRateMultiLocation
distribution
Distribution
BenchmarkDistribution
total
Total
Float
ReplyRateSingleLocation
benchmarkValue
Local benchmark reply rate
Float
total
Total
Float
ResponseBusiness
id
Business id
Long
name
Business name
String
ResponseLocation
business
Which Business this Location belongs to
ResponseBusiness
id
Location id
Long
name
Location name
String
ResponseTemplate
businesses
The list of business ids the templated was created for
[ResponseBusiness,...]
createdBy
The author who created the template
ResponseUser
dateCreated
The date in which the template was created
DateTime
id
The Uberall unique id of the template
Long
lastEdited
The date in which the template was last edited
DateTime
lastEditedBy
The author who last edited the template
ResponseUser
message
The reply's text of the template
String
status
The status of the template
String
tags
The list of tags for the template
[String,...]
title
The title of the template
String
usageCount
Number of times a template has been used
Long
ResponseUser
firstname
User First Name
String
id
User id
Long
lastname
User Last Name
String
RuleResponse
businesses
List of business ids that identify this Auto Response Rule
[ResponseBusiness,...]
canEdit
The current user can edit this rule when they have access to all businesses and locations that identify this rule
Boolean
dateCreated
Date and time of creation
DateTime
dateUpdated
Date and time of last update
DateTime
excludedLocations
List of location ids that do not identify this Auto Response Rule, even when they might belong to a business that does identify this rule
[ResponseLocation,...]
id
Uniquely identifies this Auto Response Rule
String
locationCount
Count of locations to which this rule applies
Integer
locations
List of location ids that identify this Auto Response Rule
[ResponseLocation,...]
name
Name for this Auto Response Rule
String
responses
Possible responses for this Auto Response Rule
[String,...]
status
Status of this Auto Response Rule, either ACTIVE or INACTIVE
RuleStatus
triggers
Triggers that apply to this Auto Response Rule, can be ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR
[String,...]
SalesPartner
aggregateInvoicesToParent
(only used for child SalesPartner) Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice
boolean
attribution
Attribution details of the SalesPartner
Attribution
canSeePrices
Indicates if the SalesPartner should be allowed to see price information for e.g. product plans
Boolean
contactPerson
The contact person
User
emailCustomerSupport
Customer support email of the SalesPartner
String
emailProjectLead
Project lead email of the SalesPartner
String
forceSso
If set to true, all users of this SalesPartner will only be allowed to log in our app via the SSO flow. If set to false and "isSsoActive" is set, users can either log in via normal login or SSO
boolean
identifier
Identifier for SalesPartner, must be unique for child SalesPartner within parent SalesPartner
String
isSsoActive
If set to true this will activate the single sign-on flow for logging into our app. Note that all more details need to be set before it can be used.
boolean
minPasswordLength
Minimum password length
Integer
name
The name
String
phone
The phone number
String
preferredLanguage
Preferred language of the SalesPartner, for invoice purpose (either 'de' oder 'en')
Locale
pushUrl
URL where selected webhook events should be sent to
String
resellerType
Applicable only for Sales Partner type = CUSTOM. Can be one of OEM_RESELLER or STANRAD_RESELLER. Depending on the selection, different reports in Advanced Analytics will be shown.
ResellerType
salesPartnerStatus
SalesPartner status of the SalesPartner (Be aware: Only sending 'INACTIVE' for child SalesPartner update is allowed)
SalesPartnerStatus
subscribedWebhookEventTypes
List of all event types the SalesPartner want to receive push messages for via webhook functionality, for a list of all possible types use the GET /api/salespartners/subscribable-event-types endpoint
[LoggingEvent$Type,...]
type
The type, e.g. STANDARD or CUSTOM
SalesPartnerType
whitelabelInformations
List of the sales partner's white-label information
[WhitelabelInformation,...]
whitelistedRedirectUrls
Domains that are allowed to be redirected to upon finalizing a directory connect flow
[String,...]
SalesPartnerResponse
id
The uberall unique SalesPartner id
Long
identifier
Identifier for SalesPartner, must be unique for child SalesPartner within parent SalesPartner
String
name
Name of SalesPartner
String
privateKey
PrivateKey of the SalesPartner (only filled for APPROVED SalesPartners)
String
status
Status of the SalesPartner
SalesPartnerStatus
SalesPartnerStatus
APPROVED
Approved status
SalesPartnerStatus
CREATED
Created status
SalesPartnerStatus
DECLINED
Declined status
SalesPartnerStatus
DELETED
Deleted status
SalesPartnerStatus
INACTIVE
Inactive status
SalesPartnerStatus
SearchData
city
City
String
country
Country. One of AT, CH, DE, ES, UK, FR, IT, NL
Country
id
The uberall unique id
Long
name
The location's name
String
street
The location's street address
String
streetNo
The location's street number
String
token
The token you will need for /api/search/$id
String
zip
Zip code
String
SearchRanksMultiLocationHomepageResponse
googleDirectSearch
Google Direct Search
GoogleSearchResultsMultiLocation
googleDiscoverySearch
Google Discovery Search
GoogleSearchResultsMultiLocation
SearchRanksSingleLocationHomepageResponse
googleDirectSearch
Google Direct Search
GoogleSearchResultsSingleLocation
googleDiscoverySearch
Google Discovery Search
GoogleSearchResultsSingleLocation
ServiceArea
name
Required - The name of the service area, e.g. Berlin, Deutschland
String
placeId
Required - A unique place id , e.g. ChIJAVkDPzdOqEcRcDteW0YgIQQ, Place IDs uniquely identify a place in the Google Places database and on Google Maps. Please visit https://developers.google.com/places/place-id for more info
String
ServiceItem
category
Business category the service should be applied to - this is required when applying a Google structured service but not necessary for freeform services.
Long
country
The country where the locations providing this service are located - this is required when applying a Google structured service but not necessary for freeform services.
String
currency
The currency of the price for this service - required when a price is given
Currency
description
Description
String
googleService
The Google name for a structured service - this is required when applying a Google structured service but not necessary for freeform services.
String
identifier
Unique Identifier
String
listName
Name of the section this item belongs to (e.g. "Weekly menu")
String
price
Price of the service item
Integer
title
Required - Name of the service item as represented at the location
String
SocialPost
alertType
A special type for Google ALERT posts. Possible values are COVID_19.
String
businessIds
The list of businesses IDs as entered when creating/updating the Social Post.
[Long,...]
businessPageIds
uberDoc.object.SocialPost.businessPageIds.description
[Long,...]
callToAction
A callToAction type for a google "Special Info" (SocialPost.type=POST). Currently only supported for Google Posts. Possible values are [BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP]
String
couponCode
A couponCode for redeeming a "Special Offer" (SocialPost.type=OFFER). Currently only supported for Google Posts.
String
dateEnd
The ending date of the Social Post (type=OFFER). The post will be removed from the listings at that date. It also determines when a special offer should end.
DateTime
dateStart
The starting date of EVENT and OFFER type Social Posts. It is used to indicate when an EVENT/OFFER will start. For API versions older than 20210804, it is used as publicationDate.
DateTime
description
The description of the Social Post. For type QUESTION_AND_ANSWER this is going to be the answer.
String
directories
Required - The list of directories as entered when creating/updating the Social Post.
[String,...]
excludedLocationIds
List of locationIds that should be excluded from the request. Can be used in combination with businessId when some locations should not be considered.
[Long,...]
firstComment
uberDoc.object.SocialPost.firstComment.description
String
isStoreLocator
When enabled, the SocialPost will be visible in StoreLocator.
Boolean
labels
The list of location labels as entered when creating/updating the Social Post.
[String,...]
listingPageIds
uberDoc.object.SocialPost.listingPageIds.description
[Long,...]
locationGroupIds
uberDoc.object.SocialPost.locationGroupIds.description
[Long,...]
locationIds
The list of locations IDs as entered when creating/updating the Social Post.
[Long,...]
photos
The social post's photos
[PhotoContainer,...]
publicationDate
Required - The date on which the Social Post will be published. It is used to schedule posts in the future.
DateTime
status
The current status of the Social Post (scheduled, active, inactive, deleted, not_published, published, impossible)
Status
termsAndConditions
Terms and Conditions for redeeming a "Special Offer" (SocialPost.type=OFFER). Currently only supported for Google Posts.
String