ApiVersion _20240220 (Feb 2024)
- WEB-1459 Internal change only, API isn't public to our customers
ApiVersion _20230721 (July 2023)
- DM-2458 - For clients with Collections activated in any product plan, ServiceItems, location update endpoint (POST/PUT/GET /api/location/:id) now is:
"services": [{ "identifier": "identifier-analytics-215", "id": 43574, // id is required to re use the same services instead of creating one again "title": "Advanced Analytics", "description": "Advanced Analytics Description", "category": 5, // this is uberall category "price": 5000, // results in 50,00 same as contentlist "currency" : "EUR", "googleService": "gmb_related_service_id", "translations": { "de": { // german translations "title": "german title", "description": "german description" } } }....]
ALL API VERSIONS (May 30, 2023)
Beginning on May 30, Uberall will no longer support backward compatibility to TLS version 1.0/1.1 via APIs. The change is being made for security reasons in concert with other technology partners such as, Google, Apple, Microsoft and Mozilla.
TLS (Transport Layer Security) is a security protocol first defined in 1999 for HTTPS to establish encryption channels over public networks. TLS 1.2 is the upgrade to 1.0/1.1 to address potential security weaknesses in 1.0/1.1. Uberall's technology, UI and APIs don't use TLS 1.0/1.1, and are all encrypted using the preferred protocol HTTPS/TLS 1.3. Uberall also continues to support TLS 1.2.
After May 30, API requests using the outdated security protocol TLS 1.0/1.1 will fail.
ApiVersion _20230407 (April 2023)
- LIS-1246 introduces multiple UTM fields (Google, Facebook, Bing)
- websiteExtra merged with type = Google
ApiVersion _20230115 (January 2023)
- EE-1295 Social Post supports multiple CTAs
For SocialPost before it was:
{ ..., "callToAction": "LEARN_MORE", "url": "https://www.uberall.com", ... }
now it is
{ ..., "callToActions": [ { "directory": "GOOGLE", "type": "ORDER", "url": "https://youtu.be/1shUmwihK74" }, { "directory": "FACEBOOK", "type": "ORDER", "url": "https://youtu.be/1shUmwihK74" } ], ... }
ApiVersion _20230110 (July 2023)
- WEB-780 changes to the StoreFinder settings response
- rename googleAPIKey to mapApiKey
- remove googleAPIVersion
ApiVersion _20221208 (December 2022)
- LIS-1471 Social Post photos now have a description
ApiVersion _20220222 (February 2022)
- DM-364 rename location.futureOpeningDate to location.openingDate
- DM-618 make ContentObjects have a single image
ApiVersion _20211102 (November 2021)
- UB-35939 use new ServiceItems structure
For ServiceItems, location update endpoint (POST/PUT/GET /api/location/:id) previously
"services": ["service1", "service2"]
now it is
"services": [{ "identifier": "identifier-analytics-215", "id": 43574, // id is required to re use the same services instead of creating one again "title": "Advanced Analytics", "description": "Advanced Analytics Description", "category": 5, // this is uberall category "price": 5000, // results in 50,00 same as contentlist "currency" : "EUR", "googleService": "gmb_related_service_id", "translations": { "de": { // german translations "title": "german title", "description": "german description" } } }....]
ApiVersion _20211005 (October 2021)
- UB-38806 add translations to advanced filters at ApiStoreFinderController@filters response
ApiVersion _20210907 (September 2021)
- UB-36626 returning all photos at ApiStoreFinderController@details response
ApiVersion _20210804 (August 2021)
- Add publicationDate param to api/socialposts endpoint. dateStart is now only compulsory for offers and events.
ApiVersion _20210824 (August 2021)
- Support to single and multiple callToActions
- Remove openNow from LocationSearchResult when it is not calculated (everywhere except for StoreFinder)
ApiVersion _20210729 (July 2021)
- Deprecate field countFieldsInSync in GET api/dashboard/listing-health. Will always return 0.
ApiVersion _20210628 (June 2021)
- Add new field defaultFeatures to features endpoint GET /api/features
ApiVersion _20210215 (February 2021)
- Add minThreadActionDate and maxThreadActionDate for DataPoint Search GET /api/datapoints
ApiVersion _20210214 (February 2021)
- ContentList rewrite
ApiVersion _20200728 (July 2020)
- Added isStoreLocator flag to SocialPost. Posts created without this flag will by default have it set to true as it was before.
ApiVersion _20200518 (May 2020)
- Some categories were deprecated and merged into existing ones. Check GET /api/categories for finding available categories
ApiVersion _20200430 (April 2020)
- Limit max location entries without fieldMask to 50 for endpoint GET /api/locations
ApiVersion._20200128 (January 2020)
-
User object
- INBOX feature is deprecated
- Replaced by INBOX_WRITE (= can see, filter and reply to reviews) and INBOX_READ (= cannot reply)
-
ProductPlan Object
- Field "active" (has been replaced by "status" (PENDING_APPROVAL, ACTIVE, INACTIVE)
ApiVersion _20191203 (December 2019)
-
Location Profile Completeness:
- Includes now the concept of classification, a location can be in 4 different completeness statues: REQUIRED, BASIC, ADVANCED, BONUS
- Each location field has now a classification that can be REQUIRED, BASIC, ADVANCED, BONUS, the sum of completed fields define the classification of the location object.
-
Labels
- Are return as objects and not as strings
- Non-admin users can now create public or adminOnly labels and use them to filter/search objects (locations, datapoints, socialposts)
ApiVersion _20191022 (September 2019)
version | field | type | nullable | default | description | |
---|---|---|---|---|---|---|
old | onlyUnread | boolean | no | false | can only be used to find unread datapoints but not the opposite | |
old | onlyUnreplied | boolean | no | false | can only be used to find unreplied datapoints but not the opposite | |
new | isRead | boolean | yes | null | can be null, can be used to find read and unread datapoints | |
new | hasReply | boolean | yes | null | can be null, can be used to find replied and unreplied datapoints | |
new | hasText | boolean | yes | null | can be null, can be used to find reviews with and without text |
ApiVersion _20190716 (July 2019)
- Google "pageStatus" has been deprecated
ApiVersion _20190702 (June 2019)
-
User Object
- New field featuresDetailed for LOCATION_WRITE user feature
-
Suggestions
- have been removed from the Location object response and a new endpoint and a new SuggestionResponse object has been created
ApiVersion _20190423 (April 2019)
-
User Object
- User feature LISTING has been deprecated and replaced by LOCATION_WRITE and LOCATION_READ
ApiVersion _20190401 (June 2019)
- New endpoint created to accept or decline suggestions: PUT /locations/$id/suggestions
- New field "status" added to SuggestionResponse
ApiVersion _20190128 (January 2019)
- New parameter "group" has been added to the endpoint POST /api/dashboardExports
ApiVersion _20190104 (January 2019)
- Limit page size to 1000 entries for endpoint GET /api/datapoints
class FooBar { int f = 3; }