uberall

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
total
Total
type
Type (ACTIONS_PHONE, ACTIONS_WEBSITE, ACTIONS_DRIVING_DIRECTIONS)
ACTIONS_PHONE, 
ACTIONS_PHONE
ACTIONS_WEBSITE, 
ACTIONS_WEBSITE
ACTIONS_DRIVING_DIRECTIONS
ACTIONS_DRIVING_DIRECTIONS
ActionsDataSingleLocation
difference
Difference
total
Total
type
Type (ACTIONS_PHONE, ACTIONS_WEBSITE, ACTIONS_DRIVING_DIRECTIONS)
AttributeWrapper
displayName
The attribute's name in the required language.
externalId
The google attribute id
groupDisplayName
Attribute group name
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"
valueMetadata
List of possible values.
[UNDEFINED,...]
valueType
The attribute type. e.g. BOOL, URL, ENUM, REPEATED_ENUM
Attribution
height
Height (in px) of the attribution logo
logoUrl
Required - URL pointing to the attribution logo
name
Required - Name of the attribution
url
Required - URL the attribution should point to
width
Width (in px) of the attribution logo
AverageRatingMultiLocation
distribution
Benchmark distribution
total
Average rating
AverageRatingSingleLocation
benchmarkValue
Local benchmark average rating
total
Average rating
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 )
addressDisplayStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
addressExtra
An address extra: e.g. building, floor...
addressExtraStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
attributes
The location's Google attributes
[Object,...]
attributesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING
attribution
Attribution logo and url for data source
attributionStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
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
cellphone
A contact mobile phone number
cellphoneStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
city
City
cityStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
claimStatus
Claim status of the listing. One of CLAIMABLE, NOT_CLAIMABLE, CLAIMED_BY_US, CLAIMED_BY_OTHERS, CLAIMING_IN_PROGRESS, UNKNOWN
contentLists
Content lists shown on the listing
[ContentList,...]
contentListsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
country
Country. One of AT, CH, DE, ES, UK, FR, IT, NL
countryStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
dateCreated
The date and time the listing was created in our database
descriptionLong
A long description (up to 1000 characters) for the location
descriptionLongStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
descriptionShort
A short description (up to 200 characters) for the location
descriptionShortStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
directoryType
The directory where this listing appears
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
email
A contact email for the location
emailStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
fax
The location fax number
faxStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
imprint
The location's imprint
imprintStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING
keywords
Keywords describing the locations activity
[String,...]
keywordsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
languages
Languages spoken at the location
[String,...]
languagesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
lat
The latitude of the listing
latStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
legalIdent
A legal identifier of the location. SIRET number in France
legalIdentStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
listingId
The listing id in the directory's database
listingUrl
The listing url on the directory's website
lng
The longitude of the listing
lngStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
name
The location's name used for this listing
nameDescriptor
The location's name descriptor (submitted to Facebook).
nameDescriptorStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
nameStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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.
npiStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
numberOfRatings
Number of ratings
numberOfRatingsStatus
The sync status of this specific field. One of NOT_APPLICABLE or PRESENT
openingDate
The original opening date of the business
openingDateStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
openingHoursNotesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
openingHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
paymentOptions
Payment options available at the location
[String,...]
paymentOptionsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
phone
The location's contact phone number
phoneStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
photos
Boolean indicating whether or not the listing has photos
photosStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
province
Province. Only send when not blank
provinceStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
rating
Average rating of the listing
ratingStatus
The sync status of this specific field. One of NOT_APPLICABLE or PRESENT
serviceAreas
Service areas available on the location.
[ServiceArea,...]
serviceAreasStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
socialPost
Social Post
socialPostStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
socialProfiles
Social profiles of the location
socialProfilesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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.
specialOpeningHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
street
The location's street address
streetAndNo
A localized combination of street and streetNo
streetAndNoStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
streetNo
The location's street number
streetNoStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
streetStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
streetTypeStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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)
taxNumber
The tax number of the location. CIF/NIF in Spain
taxNumberStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
transactionLinksStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
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
website
A valid url for the location's website (use UTMs to add tracking)
websiteStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
zip
Zip code
zipStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
BenchmarkDistribution
aboveBenchmark
Location count performing better than local benchmark
belowBenchmark
Location count performing worse than local benchmark
BrandDataPoint
actionDate
The date when the review/photo/... was published in the online directory
author
Username of the datapoints author
authorImage
Author profile picture url
countComments
Number of comments to this item.
countLikes
Number of likes to this item
data
Content of the datapoint (text of the review, url of the photo, count of checkins...)
dateCreated
The date the datapoint was found
directLink
A link to the online profile
directoryType
Online directory reference name
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"
lastUpdated
Date of last update
liked
Whether this datapoint has been liked or not
rating
Rating given by the user. Float value, max: 5.
repliedByOwner
True if the owner of the business has replied
secondaryData
Additional info about the datapoint (eg. text content on instagram pictures)
threadActionDate
The date of the last interaction in that thread. When a review receives a new comment, the parent will update.
type
Datapoint Type. Values: [PHOTO, REVIEW, CHECKIN, CONVERSATION, QUESTION]
Business
addressLine2
An address extra: e.g. building, floor...
businessSyncable
True if the business is allowed to start a sync. Only relevant for Businesses with more than 10 locations.
city
City of the business
country
Country of the business
countryPrices
List of country specific prices
customFields
Custom fields allow for additional information to be added at the location level. All locations within the business will have the same list of custom fields.
[String,...]
dateCreated
The date and time the business was created in uberall database
dateExpiration
The date the businesss contract expires
effectiveDate
Date when the business automatically changes its product plan to the new product plan (defined by nextProductPlanId)
id
The uberall unique id for the business
identifier
The business identifier based on your internal identification system
name
The businesss name
nextProductPlanId
ID of the next product plan applied for the business on the defined effectiveDate
numOfLocations
Number of active locations
phone
Businesss phone number
productPlan
The chosen product plan
province
Province. Only send when not blank
status
Businesss status
streetAndNo
Address of the business
type
Business type. One of SMB or ENTERPRISE
zip
Zipcode of the business
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.
type
Google, Facebook, or Bing
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
name
The category description
parent
The parent category
selectable
Boolean indicating whether the category can be used
ConflictingRuleResponse
id
id of conflicting Auto Response Rule
name
Name of conflicting Auto Response Rule
ConnectFlowUserDetails
dateConnected
This should indicate the date that this user made the connection
defaultForBusiness
This should indicate whether the connection in place has been produced by a business level connection
defaultForSalesPartner
This should indicate whether the connection in place has been produced by a salesPartner level connection
email
Connected account detail (email)
name
Connected account detail (Account name)
ConnectorFormat
CABLE
Used when the Connector is a Cable
SOCKET
Used when the connector is a Socket
ConnectorType
CHADEMO
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
DOMESTIC_A
Standard/Domestic household, type A, NEMA 1-15, 2 pins
DOMESTIC_B
Standard/Domestic household, type B, NEMA 5-15, 3 pins
DOMESTIC_C
Standard/Domestic household, type C, CEE 7/17, 2 pins
DOMESTIC_D
Standard/Domestic household, type D, 3 pin
DOMESTIC_E
Standard/Domestic household, type E, CEE 7/5 3 pins
DOMESTIC_F
Standard/Domestic household, type F, CEE 7/4, Schuko, 3 pins
DOMESTIC_G
Standard/Domestic household, type G, BS 1363, Commonwealth, 3 pins
DOMESTIC_H
Standard/Domestic household, type H, SI-32, 3 pins
DOMESTIC_I
Standard/Domestic household, type I, AS 3112, 3 pins
DOMESTIC_J
Standard/Domestic household, type J, SEV 1011, 3 pins
DOMESTIC_K
Standard/Domestic household, type K, DS 60884-2-D1, 3 pins
DOMESTIC_L
Standard/Domestic household, type L, CEI 23-16-VII, 3 pins
IEC_60309_2_single_16
IEC 60309-2 Industrial Connector single phase 16 amperes (usually blue)
IEC_60309_2_three_16
IEC 60309-2 Industrial Connector three phases 16 amperes (usually red)
IEC_60309_2_three_32
IEC 60309-2 Industrial Connector three phases 32 amperes (usually red)
IEC_60309_2_three_64
IEC 60309-2 Industrial Connector three phases 64 amperes (usually red)
IEC_62196_T1
IEC 62196 Type 1 SAE J1772
IEC_62196_T1_COMBO
Combo Type 1 based, DC
IEC_62196_T2
IEC 62196 Type 2 Mennekes
IEC_62196_T2_COMBO
Combo Type 2 based, DC
IEC_62196_T3A
IEC 62196 Type 3A
IEC_62196_T3C
IEC 62196 Type 3C Scame
TESLA_R
Tesla Connector Roadster-type (round, 4 pin)
TESLA_S
Tesla Connector Model-S-type (oval, 5 pin)
ContentCollection
contentLists
Mandatory - Sections within the content collections
[ContentList,...]
cuisineType
Only applicable to Menu content collections - indicates the cuisine the restaurant serves
description
A description of the collection
identifier
Mandatory - A unique identifier for the collection
locationIds
Location Ids that should be associated with this collection
[Long,...]
name
Mandatory - Name of the content collection
type
Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM
url
Applicable to Menu collections only - url to the brand webpage menu
ContentList
dateCreated
The date the content list was created
description
A description of the content list (section)
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
title
The name of the content list: e.g. 'Lunch Menu'
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.
ConversationCount
count
Count of conversations (via the Conversations product) in the last 30 days
directoryType
DirectoryType (Google, Facebook)
ConversionsInsightsMultiLocation
distribution
Distribution
highest
Highest
lowest
Lowest
total
Total
ConversionsInsightsSingleLocation
difference
Difference
highest
Highest
total
Total
CurrentPreviousValue
current
The value for the current period
previous
The value for the previous period
CustomItem
category
optional, a category name, e.g. 'Coffee'
currency
optional, indicating the currency for price and priceMax in ISO-4217, e.g. EUR
description
Description
id
The uberall unique id for the custom item
identifier
Unique Identifier
image
Image of the custom-item (use the Image object format)
listName
Name of the section this item belongs to (e.g. "Weekly menu")
price
optional, the price of the custom, e.g. 1500 ( i.e. 15,00 EUR )
priceMax
optional, indicating there is a price range, e.g. 2500 ( i.e. 25,00 EUR )
title
Required - mandatory, the custom name, e.g. 'Strong Coffee'
unit
optional, indicating the unit of measure, e.g. 'per kg'
url
optional, a url related to the custom item
video
optional, a video about the custom
CustomerFeedback
averageRating
Average rating obtained
countByRating
Average count by rating
[Map,...]
interactionCount
The number of review and photos
matchedLocationsCount
The number of locations matching the given textFilter query
ratingCount
The total count of rating
repliedCount
The count of replied reviews
unreadInteractionCount
The number of reviews and photos unread
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.
interactionCountByPeriod
The number of reviews and photos unread by period
[Map,...]
matchedLocationsCount
The number of locations matching the given textFilter query
totalRatingCount
The total number of reviews with rating in the given time span.
CustomerFeedbackKeyword
aggregatedWords
Contains the list of similar words that have been aggregated to this CustomerFeedbackKeyword object
[String,...]
keyword
The actual Keyword
percentage
How many documents contained the keyword at least once
rating
The average rating of all Reviews that contained this keyword at least once
ratingSum
Sum of ratings of reviews in which a keyword is present
CustomerFeedbackKeywords
keywords
The list of keywords
totalFeedbacksAnalyzed
The total number of Feedbacks that have been analyzed.
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
CustomerFeedbackMultiLocationHomepageResponse
averageRating
Average rating
replyRate
Reviews reply rate
CustomerFeedbackSingleLocationHomepageResponse
averageRating
Average rating
replyRate
Reviews reply rate
DashboardExportData
end
End date of export
group
A time grouping parameter among HOUR, DAY, WEEK, MONTH, YEAR
language
Language of a generated PDF report (e.g. 'de', 'fr', 'en')
locationIds
A list of location IDs for which to generate a report
[Long,...]
salesPartnerCountry
Country of the SalesPartner
start
Start date of export
status
Current status of the export process (e.g. 'FINISHED', 'SCHEDULED', 'FAILED')
token
Token of the export job
whitelabelIdentifier
Whitelabel identifier which will be used in the outline of the PDF report
DashboardExportInsightsDataResponse
fileUrl
The download link. Only available when status is FINISHED.
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.
DashboardLocation
businessName
Name of the business
DataPoint
actionDate
The date when the review/photo/... was published in the online directory
author
Username of the datapoints author
authorImage
Author profile picture url
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.
countLikes
Number of likes to this item
data
Content of the datapoint (text of the review, url of the photo, count of checkins...)
dateCreated
The date the datapoint was found
directLink
A link to the online profile
directoryType
Online directory reference name
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"
lastUpdated
Date of last update
liked
Whether this datapoint has been liked or not
locationId
The Location ID associated with this datapoint
rating
Rating given by the user. Float value, max: 5.
repliedByOwner
True if the owner of the business has replied
secondaryData
Additional info about the datapoint (eg. text content on instagram pictures)
threadActionDate
The date of the last interaction in that thread. When a review receives a new comment, the parent will update.
type
Datapoint Type. Values: [PHOTO, REVIEW, CHECKIN, CONVERSATION, QUESTION]
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,...]
crossfeedFilterId
The id of a filter saved by a user in the Feed
dataPointTypes
The list of data point types (REVIEW or PHOTO) for which the dataPoints should be filtered
dateEnd
The maximum date for which the dataPoints should be filtered
dateStart
The minimum date for which the dataPoints should be filtered
directories
The list of directories for which the dataPoints should be filtered
hasReply
Flag to set when only datapoints with a reply should be shown
hasText
Flag to set when only datapoints with text should be shown
isRead
Flag to set when only datapoints should be shown that the current user already read
labels
The list of labels for which the dataPoints should be filtered
[String,...]
name
Required - The filter name
ownerId
The id of the user that owns the filter
ownerName
The name of the user that owns the filter
query
Any combination of words that should be checked in the dataPoints text, reply messages and author
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
shared
Defines if the filter is shared or not
subscriberIds
The list of user's ids that are subscribed to the filter
[Long,...]
timeSpan
The date range for which the dataPoints should be filtered.
DataPointTimeSeriesResponse
timeseries
A list of TimeSeriesValues
DataPointTimeSeriesValue
datapoints
A map with the count of datapoints, for each type, for the specific date
Map
date
The Date
DatapointStatisticsResponse
averageRating
Average rating obtained
checkinCount
Number of checkins
directories
Breakdown by directory
Map
pendingApprovalCount
Number of replies pending approval
photoCount
Number of photos
postCount
Number of posts
questionCount
Number of questions
ratingCount
Number of ratings
reviewCount
Number of reviews
totalCount
Total number of datapoints
unreadCount
Number of unread datapoints
DirectoriesDetailsCountry
countryCode
Code for country that directory supports in ISO 3166 alpha-2 format
directoryDetails
Object that holds details for directory
DirectoryBrandPageResponse
businesses
list of all the business ( directory brands) from the external directory
nextPageOffset
offset for the next page from the external directory
DirectoryConnectInfo
status
Listing Connect Status [CONNECTED, NOT_CONNECTED, NOT_NEEDED]
userDetails
The information present for the account that has made this connection
DirectoryContactDetails
email
Email address to be used to release a claim from another provider
website
Contact website address to be used to release a claim from another provider
DirectoryDetails
directoryName
Name of the directory
isSearchable
Indicates whether directory has a search API that can be used
DirectoryExternalBusinessResponse
categories
list of categories - oftenly the external ids being maintained for the categories on uberall side
[String,...]
countryCode
country code for the business eg: en-US
id
id of the business on external directory
locationsCount
count of locations under the business
names
list of names for the business
[String,...]
state
status of business on external directory
urls
list of urls for the business
[String,...]
DirectoryPageResponse
additionalInfo
uberDoc.object.DirectoryPageResponse.additionalInfo.description
id
The Uberall unique id for the directory page
level
The level of the page. It is either the business or listing page. [BUSINESS, LISTING]
name
The Directory Page name on the directory
type
The Directory Page type [BUSINESS_PAGE, DIRECTORY_PAGE]
DoctorComData
credentials
Medical professional's credentials (max character limit: 25)
doctorCategories
Doctor.com categories
[Long,...]
hospitalAffiliations
Hospital affiliations
insurancesAccepted
Types of insurance accepted by the provider
isProvider
Defines if the listing is for a provider or not
npi
National Provider Id (NPI)
practiceName
Name of the medical practice
providerFirstname
Medical professional's first name
providerMiddlename
Medical professional's middle name
providerSurname
Medical professional's surname
providerTitle
Medical professional's title
university
The University where the provider received their degree
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, SOCIAL_POST_PENDING_APPROVAL_NOTIFICATION, NEW_CHATS_NOTIFICATION, NEW_CONTACT_FORM_NOTIFICATION
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.
EvConnector
amperage
Required - Required - The maximum amperage of the connector
int
format
Required - Required - The format of the connector, whether it is a socket or a plug
identifier
Required - Required - Identifier of the connector within the EVSE created by the CPO. Two connectors may have the same id as long as they do not belong to the same EVSE object.
powerType
Required - Required - Connector Power Type. Values can be: AC_1_PHASE, AC_3_PHASE, DC
standard
Required - Required - The socket or plug standard of the charging point
updateTime
Required - Date/time of the connectors last update
voltage
Required - Required - The voltage of the connector
int
EvData
isChargingClosed
Indicates if the EVSEs can be used for charging outside the opening hours of the location. E.g. when the parking garage closes its barriers overnight, it will indicate if you still can charge till the next morning
operator
Required - Required - Operator of the chargepoints of the location
owner
Required - Required - Owner of the location
subOperator
Suboperator of the chargepoints of the location
supplyEquipments
Charging Station information
timezone
Required - The time zone of the location
type
Type of location of the charging station
updateTime
Required - Date/time of the last EV data update
EvLocationType
ON_STREET
Used when the EV Charging station is located on a street
OTHER
Used when no other EV Charging station location description applies
PARKING_GARAGE
Used when the EV Charging station is located in a Parking Garage
PARKING_LOT
Used when the EV Charging station is located in a Parking Lot
UNDERGROUND_GARAGE
Used when the EV Charging station is located in an Underground Garage
UNKNOWN
Used when the EV Charging stations location is unknown
EvStatus
AVAILABLE
The EVSE/Connector is able to start a new charging session.
BLOCKED
The EVSE/Connector is not accessible because of a physical barrier, i.e. a car.
CHARGING
The EVSE/Connector is in use.
INOPERATIVE
The EVSE/Connector is not yet active or it is no longer available (deleted).
OUTOFORDER
The EVSE/Connector is currently out of order.
PLANNED
The EVSE/Connector is planned, will be operating soon.
REMOVED
The EVSE/Connector/charge point is discontinued/removed.
RESERVED
The EVSE/Connector is reserved for a particular EV driver and is unavailable for other drivers.
UNKNOWN
No status information available. (Also used when offline)
EvSupplyEquipment
connectors
Required - Details on each connector
[EvConnector,...]
evseId
Required - Unique id for the outside world. Compliant with “eMI3standard version V1.0”
parkingRestrictions
This value, if provided by CPO, represents the restriction to the parking spot for different purposes
physicalReference
A number/string printed on the outside of the EVSE for visual identification
uid
Required - Unique ID in the system of the CPO
updateTime
Required - Date/time of the Equipments last update
Event
description
The description of the event: e.g. "Watch a lot of awesome movies."
identifier
Unique Identifier for the Event
listName
Name of the Event
timeEnd
Required - The date the event ends
timeStart
Required - The date the event starts
title
Required - The title of the event
url
The url of the page with more details about the event
video
A video to promote the event
FeaturesResponse
defaultFeatures
A list with the default features for the user.
[Feature,...]
locations
Get user features partitioned by location.
FeedItem
date
Action date of the feed item
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]
FiltersResponse
businesses
List of business ids and names
[Map,...]
countries
List of countriy names
[Country,...]
directories
List of directory names
labels
List of labels
[String,...]
GoogleSearchResultsMultiLocation
firstPageLocationRatio
Ratio of locations appearing on the first page of search results (top 10 results)
top3LocationRatio
Ratio of locations appearing in the top 3 results of search
GoogleSearchResultsSingleLocation
firstPage
Does the location appear on the first page of search results (top 10 results)
top3
Does the location appear within the top 3 results of search
HeaderMultiLocationHomepageResponse
attractScore
Score for ATTRACT Pillar
categories
List of most frequently used categories for all locations
[String,...]
categoriesCount
Count of different categories for all locations
citiesCount
Count of different cities for all locations
countriesCount
Count of different countries for all locations
delightScore
Score for DELIGHT Pillar
globalScore
'Near Me' 360 score
locationCount
Count of all locations
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)
standOutScore
Score for STAND_OUT Pillar
HeaderSingleLocationHomepageResponse
attractScore
Score for ATTRACT Pillar
delightScore
Score for DELIGHT Pillar
globalScore
'Near Me' 360 score
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)
standOutScore
Score for STAND_OUT Pillar
Image
description
Description of the image
id
The uberall unique id for the image
type
Required - The image type, one of [LOGO, MAIN, IMAGE]
uid
Required - user identifier of the image
url
Required - Image url
ImpressionsInsightsMultiLocation
distribution
Distribution
total
Total
ImpressionsInsightsSingleLocation
difference
Difference
total
Total
InboxResponse
count
The total number of datapoints
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
pageSize
The number of datapoints to show on each page
status
Status indicating whether Inbox is active for the current location. One of ACTIVE INACTIVE
Insights
matchedLocationsCount
The number of locations matching the filter which the insights are returned for
metrics
Google:
BUSINESS_IMPRESSIONS_DESKTOP_MAPS 
BUSINESS_IMPRESSIONS_DESKTOP_SEARCH 
BUSINESS_IMPRESSIONS_MOBILE_MAPS 
BUSINESS_IMPRESSIONS_MOBILE_SEARCH 
BUSINESS_CONVERSATIONS 
BUSINESS_DIRECTION_REQUESTS 
CALL_CLICKS 
WEBSITE_CLICKS 
BUSINESS_BOOKINGS 
BUSINESS_FOOD_ORDERS 
BUSINESS_FOOD_MENU_CLICKS
Deprecated Google Metrics:
(To be used to fetch historical data)
QUERIES_DIRECT 
QUERIES_INDIRECT 
VIEWS_MAPS 
VIEWS_SEARCH 
ACTIONS_WEBSITE 
ACTIONS_PHONE 
ACTIONS_DRIVING_DIRECTIONS 
PHOTOS_VIEWS_MERCHANT 
PHOTOS_VIEWS_CUSTOMERS 
LOCAL_POST_VIEWS_SEARCH 
LOCAL_POST_ACTIONS_CALL_TO_ACTION
Facebook:
PAGE_IMPRESSIONS 
PAGE_CONSUMPTIONS
Bing:
CLICKS_DESKTOP_CORTANA_CALL 
CLICKS_DESKTOP_CORTANA_DIRECTIONS 
CLICKS_DESKTOP_CORTANA_PHOTOS 
CLICKS_DESKTOP_CORTANA_WEBSITE 
CLICKS_DESKTOP_MAPS_CALL 
CLICKS_DESKTOP_MAPS_DIRECTIONS 
CLICKS_DESKTOP_MAPS_PHOTOS 
CLICKS_DESKTOP_MAPS_WEBSITE 
CLICKS_DESKTOP_SEARCH_PAGE_CALL 
CLICKS_DESKTOP_SEARCH_PAGE_DIRECTIONS 
CLICKS_DESKTOP_SEARCH_PAGE_PHOTOS 
CLICKS_DESKTOP_SEARCH_PAGE_WEBSITE 
CLICKS_MOBILE_CORTANA_CALL
CLICKS_MOBILE_CORTANA_DIRECTIONS 
CLICKS_MOBILE_CORTANA_PHOTOS 
CLICKS_MOBILE_CORTANA_WEBSITE 
CLICKS_MOBILE_MAPS_CALL 
CLICKS_MOBILE_MAPS_DIRECTIONS
CLICKS_MOBILE_MAPS_PHOTOS 
CLICKS_MOBILE_MAPS_WEBSITE 
CLICKS_MOBILE_SEARCH_PAGE_CALL 
CLICKS_MOBILE_SEARCH_PAGE_DIRECTIONS 
CLICKS_MOBILE_SEARCH_PAGE_PHOTOS 
CLICKS_MOBILE_SEARCH_PAGE_WEBSITE 
IMPRESSIONS_DESKTOP_CORTANA 
IMPRESSIONS_DESKTOP_MAPS 
IMPRESSIONS_DESKTOP_SEARCH_PAGE 
IMPRESSIONS_MOBILE_CORTANA 
IMPRESSIONS_MOBILE_MAPS 
IMPRESSIONS_MOBILE_SEARCH_PAGE
Yelp:
NUM_CALLS 
NUM_DIRECTIONS_AND_MAP_VIEWS 
NUM_PAGE_VIEWS URL_CLICKS
Map
InsightsBenchmarkDistribution
aboveBenchmark
Location count performing better than local benchmark
belowBenchmark
Location count performing worse than local benchmark
InsightsDataMultiLocationHomepageResponse
conversions
Conversions data on Google
impressions
Impressions count on Google
totalLocations
Location count
InsightsDataSingleLocationHomepageResponse
conversions
Conversions data on Google
impressions
Impressions count on Google
InteractionsHomepageResponse
conversations
Conversations
googleQuestionsCount
Count of user-generated questions on Google in the last 30 days
Label
adminOnly
Permission on label, whether it can be used by admins or everyone.
name
Label name as 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.
connectStatus
Connect status of the listing.
data
A map containing optional information about the listing, e.g. latestVisibilityIndex.
id
The id of the listing.
lastChecked
The last time the listing was sync-checked.
lastSuccessfulUpdate
The last time the listing was successfully updated.
listingId
The listing's id in the directory's database.
listingUrl
The listing's URL on the directory's website.
mandatoryFields
Mandatory fields for the specific Directory that are not set yet
status
The listing's status.
syncStatus
The listing's sync status.
type
The directory where this listing appears.
typeName
The directory's name in the language of the current locale.
ListingDetails
action
Action Required [CONNECT, VERIFY, CLAIM, ADD_MANDATORY_FIELDS, ACCESS]
category
The category of the directory of this listing, e.g. social, search
directoryConnectInfo
The detailed information about the type of connection that exists for this listing
directoryContactDetails
Contact details of the publisher when the listing needs to be claimed
directorySpecificData
Directory specific data. e.g. Google publishing states which can be UNVERIFIED, DISABLED, SUSPENDED, DUPLICATE.
Map
listingUrl
Listing URL
mandatoryFieldsMissing
Mandatory field missing on the location which prevents the data to be submitted to the publisher
[String,...]
status
Listing Status [SYNCED, SUBMITTED, UPDATING, ACTION_REQUIRED, LINKED]
typeName
Listing type / Publisher name
ListingHealth
countFieldsInSync
(Deprecated - will always return 0) The number of fields in sync
countListingsActionRequired
The number of listings where client action is required.
countListingsBeingUpdated
The number of listings which are in the process of being updated
countListingsInSync
The number of listings in sync
countListingsLinked
The number of listings which have been linked. These listings do not get updated.
countListingsSubmitted
The number of listings in successfully submitted. These listings don't have live sync checks.
countLocationsNeedsReview
The number of locations which are in needs review.
countLocationsRequireSync
The number of locations which require to be syncronized
directoriesMissingConnect
The list of DirectoryType missing connection
ListingHealthMultiLocationHomepageResponse
facebookConnectedLocations
Count of locations connected on Facebook
googleVerifiedLocations
Count of locations connected and verified on Google Business Profile
totalLocations
Total locations
int
ListingHealthSingleLocationHomepageResponse
onlineListings
Count of listings online for the location
int
totalListings
Total listings
int
ListingsDetailsResponse
firstSyncStarted
Date & time the first sync was started on the location.
listingsResponse
Detailed response for the listings
statistic
Statistics or count of listings in different statuses
Location
activeDirectoriesCount
Output only. Number of active directories
activeListingsCount
Output only. Number of active listings
addressDisplay
Indicates if the address should be displayed or hidden
addressExtra
An address extra: e.g. building, floor...
attributes
Google attributes
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.
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.
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
categories
Required to start location sync - A list of category IDs describing the location
[Category,...]
cellphone
A contact mobile phone number
city
Required - City
cleansingComment
Cleansing comment by user, set only when cleansingStatus is INVALID_DATA. Possible Values (ADDRESS_DETAILS_VERIFIED, NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)
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
cleansingStatus
Output only. Current cleansing status for the location. Possible values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA
contentLists
The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the location
[Integer,...]
country
Required - Country of the location
customFields
A Map for identifying the value input for a specific custom field name on the location. Custom fields are created at the business level.
  "customFields": [
    {
      "name": "foo",
      "value": "bar"
    },
    {
      "name": "baz",
      "value": "qux"
    }
  ]
[Map,...]
dataPoints
Output only. Number of dataPoints (reviews, photos) left by users at this location
dateCreated
Output only. The date and time the location was created in our database
descriptionLong
A long description - up to 1000 characters, all characters must match this regexp:
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€\^£$] 
descriptionShort
A short description - up to 200 characters, all characters must match this regexp:
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€£$] 
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"
}
email
A contact email for the location
emailVerification
The locations verification status
evData
A description of the EV Charging stations location. Used to help customers find the station more easily
fax
The location fax number
features
Output only. List of features available to the location
[Feature,...]
id
Output only. The uberall unique id for the location
identifier
The location identifier based on your internal identification system
imprint
The imprint of the location
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
lastUpdated
Output only. Date of the last changes made to the location
lat
The latitude coordinate of the location
legalIdent
A legal identifier of the location. SIRET number in France
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
listingsInSync
Output only. The number of listings in sync
lng
The longitude coordinate of the location
mainPhoto
The locations main picture
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]
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
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
openingDate
The date the location will first open. Must be formatted YYYY-MM-DD
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_\*§²`´·"'\+¡¿@] 
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.
photos
The location's photos
profileCompleteness
Output only. Number representing completeness of location data, up to 100
province
Province. Only send when not blank
publishedListingsCount
Output only. Number of published listings
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)
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.
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
street
Required - The location's street address
streetNo
The location's street number
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
taxNumber
The tax number of the location. CIF/NIF in Spain
temporarilyClosed
Set a location to temporarily closed with the ability to set a re-open date. Temporarily closed is best used if a location will be closed for more than seven days. If less than seven days, use special hours to show the location is closed.
timeZone
The location's timezone
transactionLinks
Links that appear on some directories for specific types of customer actions, such as food ordering, appointment setting, and booking reservations. Only available for specific business categories.
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
website
A valid url for the location's website (use UTMs to add tracking)
zip
Zip code, optional only for some countries.
LocationDashboardResponse
location
The location linked to this dashboard
stats
Statistics related to the current location
todos
Todos related to the current location
LocationDashboardStatistics
activeDirectories
List of active directories
[String,...]
activeDirectoriesCount
Output only. Number of active directories
activeListingsCount
Output only. Number of active listings
inactiveDirectories
List of inactive directories
[String,...]
inboxActive
ACTIVE if the inbox feature is included in the plan
inboxPhotos
Number of photo datapoints
inboxReviews
Number of review datapoints
inboxTotal
Total number of datapoints
managersCount
Number of users that manage this location
profileCompleteness
Percentage of profile completeness
publishedListingsCount
Number of managed online listings
synced
Number of synced listings
unfilledFields
Unfilled location fields
[String,...]
visibilityIndex
Latest visibility index
LocationFeatureResponse
businessId
Business the location belongs to.
currentFeatures
The features enabled for the location.
[Feature,...]
id
The id of the location.
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
LocationGroup
LocationGroupListResponse
LocationManagersCount
managersCount
The number of managers managing the location
LocationPhoto
cropHeight
Height of the 16:9 cropped area [LANDSCAPE photo only]
cropOffsetX
Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
cropOffsetY
Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
cropWidth
Width of the 16:9 cropped area [LANDSCAPE photo only]
dateCreated
The date when the object was created in uberall database
description
A description for the photo - max 255 chars
identifier
The photo identifier based on your internal identification system
lastUpdated
Date of the last changes made to the photo
order
Sets the order in which the photos should be shown
sourceUrl
The URL to the original photo
type
Required - One of:
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
STOREFINDER_LOGO - Only for Uberall locator product
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
url
Required - url of the photo
LocationPhotoResponse
cropHeight
Height of the 16:9 cropped area [LANDSCAPE photo only]
cropOffsetX
Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
cropOffsetY
Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
cropWidth
Width of the 16:9 cropped area [LANDSCAPE photo only]
dateCreated
The date when the object was created in uberall database
description
A description for the photo
id
The uberall unique id for the photo
identifier
The photo identifier based on your internal identification system
locationId
The uberall unique id of this photo's location
logo
A boolean indicating whether this photo is the location's logo. Maximum one logo per location
main
A boolean indicating whether this photo is the location's main photo. Maximum one per location
publicUrl
A public url for this photo
repoKey
File name
sourceUrl
The client supplied url for a photo
thumbnailUrl
Url for the image thumbnail
type
Required - One of:
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
STOREFINDER_LOGO - Only for Uberall locator product
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
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
LocationResponse
location
A complete Location object
suggestionsForFields
Map containing fields and the suggested values from different directories.
[Map,...]
suggestionsForFieldsAvailable
true if any suggetions are available
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.
addressExtra
An address extra: e.g. building, floor...
attributes
The location's Google attributes
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.
businessId
The id of the business associated with this location
cancellationDate
The date when the location was cancelled
categories
Required - A list of category IDs describing the location
[Category,...]
cellphone
A contact mobile phone number
city
City
country
Country. One of AT, CH, DE, ES, UK, FR, IT, NL
dateCreated
The date and time the location was created
descriptionLong
A long description (up to 1000 characters) for the location
descriptionShort
A short description (up to 200 characters) for the location
distance
Used for store finder. The distance between the current position and this location
email
A contact email for the location
endDate
The date the location's contract expires
fax
The location fax number
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
id
The uberall unique id for the location
identifier
The location identifier based on your internal identification system
imprint
imprint of the location
keywords
Keywords describing the locations activity
[String,...]
labels
Labels grouping similar locations
[Label,...]
lastSyncStarted
Output only. Date of the last sync for the location
lastUpdated
Output only. Date of the last changes made to the location
lat
The latitude coordinate of the location
legalIdent
A legal identifier of the location. SIRET number in France
lng
The longitude coordinate of the location
locationSyncable
Boolean indicating whether the location has been updated and can be synced
name
The location's name
openNow
Used for store finder. Boolean indicating whether the location is currently open
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
phone
The location's contact phone number
photos
List of Photos
province
Province. Only send when not blank
skipFacebookPicturesUpdate
Skip updating photos on Facebook
socialPostId
Social Post Id of the location
sortableData
A JSON indicating which parameters can be used when sorting a list of locations including this one
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.
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
street
The location's street address
streetNo
The location's street number
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
suggestionsForFieldsAvailable
true if any suggetions are available
taxNumber
The tax number of the location. CIF/NIF in Spain
website
A valid url for the location's website (use UTMs to add tracking)
zip
Zip code
LocationStatisticsResponse
count
Total number of locations
countActive
Number of active locations
countCancelled
Number of cancelled locations
countClosed
Number of closed locations
countInactive
Number of inactive locations
countSyncNeeded
Number of locations where sync is needed
countSyncNotStarted
Number of locations where sync has not been started
countSyncStarted
Number of locations where sync has been started
suggestionsAvailable
true if any suggetions are available
LocationTask
locationId
The location id which the next best action refers to
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
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]
LocationTemporarilyClosed
reopenDate
Set a re-open date for a temporarily closed location. The location will re-open at 12:01am local time. Leave null if the re-open date is unknown.
temporarilyClosed
Required - Set a location to temporarily closed or re-open a temporarily closed location
LodgingField
category
High-level grouping of Lodging Amenity types, such as SERVICES, TRANSPORTATION, FAMILIES, etc
displayName
Amenity name as displayed in the UI, available in DE, EN, FR, ES, JA, and FI
externalId
The Google external id for each lodging amenity. Examples include: watercraftRental, turndownService, patio
LoggingEvent
dateCreated
The date the logging event was created
id
The uberall unique id for the logging event
payload
A JSON containing detailed information about the logging event
Map
source
The id of the object the logging event is about
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
LoginCommand
email
User email (email or userId is required)
password
User Password (password or private_key is required)
private_key
Private key (password or private_key is required)
userId
UserId (email or userId is required)
LoginResponse
access_token
Access Token
LogoutResponse
success
True if logout was successful
NextOpen
closedNow
true if the location is closed now; otherwise false
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)
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)
neverOpens
true if the location will never open again; otherwise false (this parameter is used only if closedNow true)
OpeningHours
closed
Indicates whether a location is closed on a day.
dayOfWeek
Required - The weekday of an opening hours, e.g.: 1 for Monday, 2 for Tuesday, ...
fromX
A beginning of a period. One or multiple periods are supported per dayOfWeek, e.g.: "from1": "09:00", "from2": "15:00"
toX
An end of a period. One or multiple periods are supported per dayOfWeek, e.g.: "to1": "14:30", "to2": "17:00"
ParkingRestriction
CUSTOMERS
Used when there is a Customers Only parking restriction
DISABLED
Used when there is a Handicap parking restriction
EV_ONLY
Used when parking is for EV Only
MOTORCYCLES
Used for Motorcycle parking
PLUGGED
Used when parking is restricted to only vehicles currently charging
Person
description
Description for the person: e.g. Responsible for the day-to-day operations of the store
id
The uberall unique id for the person
identifier
Unique Identifier for the Person
image
Image of the person (use the Image object format)
listName
Name of the section this person belongs to
name
Required - The person's full name
title
The person's title: e.g. Store manager
url
A valid url of a page with more details about the person
PhotoContainer
description
Description for the social post photo
photo
Placeholder to represent photo for a social post which can either be a base64 encoded string or a S3 link for image
redirectUrl
The URL that a user is redirected to when clicking the photo
PowerType
AC_1_PHASE
Used for stations with a 120-volt (120V) AC outlet
AC_3_PHASE
Used for stations with a fast charging or DC charging
DC
Used for stations with a DC charging outlet
PricePerCountry
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
currency
Currency used for prices in ISO-4217: e.g. EUR, USD, CHF
description
Description
id
The uberall unique id for the product
identifier
Unique Identifier
image
Image of the product (use the Image object format)
listName
Name of the section this item belongs to (e.g. "Weekly menu")
price
Price of the product in cents: e.g. 1500 for 15 €
priceMax
Maximum price if you want to use a price range for the product
title
Required - The name of the product: e.g. Strong Coffee
unit
A unit of measure, e.g. per kg
url
A valid page url with more details about the product
video
A video about the product
ProductPlan
automationDirectories
List of directories supported by this plan
billingPeriod
Period in months for which the location is billed
countryPrices
List of country specific prices
defaultMarketDevelopmentFunds
Default Market Development Funds
defaultOriginalPrice
Default Original Price in cent
defaultPlan
True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.
defaultPrice
Mandatory if countryPrices is not populated. Define a global price for the Product Plan that gets applied for all countries
defaultPriceSetup
Set-up price per location in cent
description
Description of the plan
duration
Required - Duration of the Product Plan in months
features
List of features supported by this plan
[Feature,...]
identifier
The Product Plan identifier based on your internal identification system
initialBillingPeriod
Initial Billing Period
initialDuration
Initial Duration
name
Required - The name of the product plan
status
One among PENDING_APPROVAL, ACTIVE, INACTIVE
ProductPlanCountryPriceResponse
country
Required - Country
marketDevelopmentFunds
Market Development Funds (MDF)
int
price
Required - Price for the specific Country
priceSetup
Setup fee
int
ProductPlanResponse
billingPeriod
Cadency with which an invoice is generated for this Product Plan
countryPrice
Prices per location for each supported country
currency
The abbreviation of the currency the product plan is charged in.
dateCreated
The date and time the Product Plan was created in our database
defaultMarketDevelopmentFunds
Default Market Development Funds
defaultOriginalPrice
Default Original Price in cent
defaultPlan
True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.
defaultPrice
Define a global price for the Product Plan that gets applied for all countries
defaultPriceSetup
Set-up price per location in cent
description
Description of the plan
duration
Duration of the Product Plan in months
features
List of features supported by this plan
[Feature,...]
id
The uberall unique id
identifier
The Product Plan identifier based on your internal identification system