Changelog

All notable changes will be documented in this file.

The Dashboard API (dashboard-service) was aggregated into the unified Uberall OpenAPI documentation (tag group: Products).

• GET /dashboard/customer-feedback — Get customer feedback overview.
• GET /dashboard/customer-feedback-keywords — Get customer feedback keywords.
• GET /dashboard/customer-feedback/by-period — Get customer feedback by period.
• GET /dashboard/data-availability — Get data availability date.
• GET /dashboard/excel-export — Export Excel report.
• POST /dashboard/excel-exports — Create Excel export job.
• GET /dashboard/excel-exports/{id} — Get Excel export job.
• PATCH /dashboard/excel-exports/{id} — Update Excel export job.
• GET /dashboard/excel-exports/{jobId}/download — Download Excel export file.
• GET /dashboard/export-insights-data — Export insights data.
• GET /dashboard/export-insights-data-with-threshold — Export insights data with threshold.
• GET /dashboard/insights-data — Get insight metrics.
• GET /dashboard/insights-data/warnings — Get insight data warnings.
• GET /dashboard/listing-health — Get listings health.
• GET /dashboard/listing-health/{locationId} — Get listings health by location id.
• GET /dashboard/profile-completeness — Get profile completeness.
• GET /dashboard/review-response-time — Get review response time.
• GET /dashboard/search-keywords — Get search keywords.
• GET /dashboard/suppressed-duplicates — Get suppressed duplicate locations.
• GET /dashboard/visibility-index — Get visibility index score.

The Digital Asset Management API (digital-asset-management-service) was aggregated into the unified Uberall OpenAPI documentation (tag group: Products).

• GET /dam/assets — List assets.
• GET /dam/assets/{id} — Get an asset.
• PATCH /dam/assets/{id} — Update an asset.
• DELETE /dam/assets/{id} — Delete an asset.
• GET /dam/folders — List folders.
• POST /dam/folders — Create a folder.
• GET /dam/folders/{id} — Get a folder.
• PATCH /dam/folders/{id} — Update a folder.
• DELETE /dam/folders/{id} — Delete a folder.
• POST /social-templates — Create a new social template as a digital asset.
• PATCH /social-templates/{id} — Edit an existing social template.

The Homepage API (homepage-api-service) was aggregated into the unified Uberall OpenAPI documentation (tag group: Products).

• POST /home/key-metrics — Get key metrics.
• GET /home/key-metrics/configuration — Get key metrics configuration.
• PUT /home/key-metrics/configuration — Update key metrics configuration.
• GET /home/locations/ranks — Get location rankings via GET.
• POST /home/locations/ranks — Get location rankings via POST.
• GET /home/locations/score — Get location scores via GET.
• POST /home/locations/score — Get location scores via POST.
• GET /home/suggestions — Get suggestions via GET.
• POST /home/suggestions — Get suggestions via POST.
• POST /home/suggestions/dismiss — Dismiss a suggestion.
• GET /home/tasks — Get tasks via GET.
• POST /home/tasks — Get tasks via POST.
• POST /home/tasks/dismiss — Dismiss a task.
• DELETE /home/tasks/dismiss — Undo a task dismissal.
• GET /home/tasks/locations — Get location IDs for a task type via GET.
• POST /home/tasks/locations — Get location IDs for a task type via POST.

The Social AI API (social-ai-service) was aggregated into the unified Uberall OpenAPI documentation (tag group: Products).

• POST /social-ai/generate-content — Generate AI-based social post content.

The Near Me Check API (near-me-check-service) was aggregated into the unified Uberall OpenAPI documentation (tag group: Products).

• GET /near-me-check/categories — Fetches Uberall categories.
• POST /report — Create a report.
• GET /report/{id} — Get report by id and token.

• WEB-1459 Internal change only, API isn't public to our customers

• DM-2458: For clients with Collections activated in any product plan, ServiceItems, location update endpoint (POST/PUT/GET /api/location/:id) now uses the following format:

"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" 
       }
     }
}....]

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.

• LIS-1246: Introduces multiple UTM fields (Google, Facebook, Bing)
  • websiteExtra merged with type = Google

• 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"
        }
    ],
    ...
}

• WEB-780: Changes to the StoreFinder settings response
  • Rename googleAPIKey to mapApiKey
  • Remove googleAPIVersion

• LIS-1471: Social Post photos now have a description

• DM-364: Rename location.futureOpeningDate to location.openingDate
• DM-618: Make ContentObjects have a single image

• 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" 
       }
     }
}....]

• UB-38806: Add translations to advanced filters at ApiStoreFinderController@filters response

• UB-36626: Returning all photos at ApiStoreFinderController@details response

• Add publicationDate param to api/socialposts endpoint. dateStart is now only compulsory for offers and events

• Support to single and multiple callToActions
• Remove openNow from LocationSearchResult when it is not calculated (everywhere except for StoreFinder)

• Deprecate field countFieldsInSync in GET api/dashboard/listing-health. Will always return 0.

• Add new field defaultFeatures to features endpoint GET /api/features

• Add minThreadActionDate and maxThreadActionDate for DataPoint Search GET /api/datapoints

• ContentList rewrite

• Added isStoreLocator flag to SocialPost. Posts created without this flag will by default have it set to true as it was before.

• Some categories were deprecated and merged into existing ones. Check GET /api/categories for finding available categories

• Limit max location entries without fieldMask to 50 for endpoint GET /api/locations

• 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)

• 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 returned 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)

GET /api/datapoints/filters/$id

• Google "pageStatus" has been deprecated

• 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

• User Object
  • User feature LISTING has been deprecated and replaced by LOCATION_WRITE and LOCATION_READ

• New endpoint created to accept or decline suggestions: PUT /locations/$id/suggestions
• New field "status" added to SuggestionResponse

• New parameter "group" has been added to the endpoint POST /api/dashboardExports

• Limit page size to 1000 entries for endpoint GET /api/datapoints

class FooBar {
  int f = 3;
}