API Change Log

Last Updated: February 27, 2019

2019

FEBRUARY

February 25

February 22

  • Added allergens and featuredItem fields to the Menu data model

February 20

  • Made the following changes to the logo field in the ATM, Location, Restaurant, Healthcare Professional, and Healthcare Facility Entity data models:
    • image subfield added
    • url and alternateText are now subfields of image instead of direct subfields of logo
    • clickthroughUrl and details subfields added

February 15

  • Added language field to the Review Invitation data model

February 14

  • Deprecated googlePreferredPhoto field in the Location, Restaurant, Healthcare Professional, and Healthcare Facility Entity data models

February 13

  • Added frequentlyAskedQuestions field to the ATM, Location, Restaurant, Healthcare Professional, and Healthcare Facility Entity data models

February 5

  • Made the following changes to the Location, Restaurant, Healthcare Professional, and Healthcare Facility Entity data models:
    • Added ANDROIDPAY, APPLEPAY, and SAMSUNGPAY as valid values of paymentOptions
    • Added the capability to store phone numbers that have calling codes for countries other than the country specified in the Entity’s countryCode
    • The date value in the holidayHours subfield of hours can no longer be for a date in the past.

JANUARY

January 24

  • Deprecated radius and units subfields of serviceArea field in the Location, Restaurant, Healthcare Professional, and Healthcare Facility Entity data models

January 14

  • Added facebookCallToAction field to the Location, Restaurant, Healthcare Professional, and Healthcare Facility Entity data models

January 11

January 3

January 2

2018

DECEMBER

December 17

  • Made RATINGS dimensions value available for use with all Reviews-related values of metrics, with the exception of CUMULATIVE_RATING, in the Analytics: Create Report endpoint in the Knowledge API

December 12

  • Changed encoding of Analytics: Create Report responses to UTF-8
  • Renamed mailerContactName field in Verification Initiation data model to recipientName

December 11

  • Made the following changes to the Analytics: Create Report endpoint in the Knowledge API:
    • Renamed REVIEW_RESPONSE_COUNT metrics value to RESPONSE_COUNT
    • Renamed REVIEW_RESPONSE_TIME metrics value to RESPONSE_TIME
    • Renamed REVIEW_RESPONSE_RATE metrics value to RESPONSE_RATE
    • Added CUMULATIVE_RATING value to metrics
    • Made PARTNERS dimensions value available for use with all Reviews-related values of metrics
  • Added mailerContactName field to Verification: Initiate requests in the Knowledge API

December 4

NOVEMBER

November 29

November 27

  • Added the thumbnails subfield to the following fields in the Entity data models:
    • googleCoverPhoto
    • googleProfilePhoto
    • logo
    • image subfield of photoGallery

November 19

  • Added transactionId to the Review data model

November 14

November 7

  • Added titleName field to Review Invitation data model

November 6

  • Made the following changes to the Asset data model:
    • PHOTO value of type renamed to COMPLEX_PHOTO
    • VIDEO value of type renamed to COMPLEX_VIDEO
    • The names of custom fields are now valid values of type
    • Added value field
    • Removed contents field; the content of text assets is now in the value field.
    • Removed photoUrl field
    • Removed videoUrl field
    • Removed details field
    • The following fields have been made subfields of value, with the contents of value depending on the Asset’s type:
      • image (contains url and alternateText)
      • clickthroughUrl
      • video (contains url)
      • description
    • Added locale field
    • Added owner field
    • Changed forLocations field to forEntities
    • Added the following subfields to forEntities:
      • mappingType
      • folderId
      • entityIds
      • labelIds
      • labelOperator
  • Added the templateId parameter to Entities: Create and Entities: Update endpoints in the Knowledge API

November 1

  • Removed entityIds parameter from the Entity Language Profiles: List All endpoints in the Knowledge API and Live API

OCTOBER

October 31

  • Made the following changes to the Healthcare Facility, Healthcare Professional, Location, and Restaurant Entity data models:
    • In the facebookCoverPhoto, facebookProfilePhoto, googleCoverPhoto, and googleProfilePhoto fields:
      • url and alternateText removed from image subfield and made direct subfields of the photo field (e.g., facebookProfilePhoto)
      • image subfield removed

October 29

October 19

October 15

October 9

  • Added transactionId field to the Review Invitation data model

October 2

October 1

  • Added BING_MOBILE and YAHOO_MOBILE as valid trackingSites values in the Location data model

SEPTEMBER

September 5

  • Added BITCOIN and PAYPAL as valid values of paymentOptions in the Location data model

AUGUST

August 15

August 13

August 10

  • Added usage field to Asset data model

August 9

  • Made the following changes to the Custom Field data model:
    • Added translations subfield to the options field
    • Added entityTypes subfield to the validation field
    • Added entityAvailability field
  • Changed the contents of the following fields in Custom Fields: List and Custom Field: Get responses:

August 8

  • Changed “PowerListings®” endpoint group to “Listings”
  • Changed powerlistings in endpoint URLs to listings

August 2

JULY

July 25

  • Added the following to the Analytics: Create Report endpoint in the Knowledge API:
    • KEYWORD_SENTIMENT and KEYWORD_SEARCHES values to metrics
    • REVIEW_KEYWORDS value to dimensions

July 23

  • Added the following to the Analytics: Create Report endpoint in the Knowledge API:
    • IST_AD_MATCHES and IST_AD_PRESENCE values to metrics
    • PUBLISHERS value to dimensions

July 10

  • Added the reviewLabels field to the Review data model and changed the availability of the labelIds field

JUNE

June 28

  • Added the reviewLanguage field to the Review data model
  • Added reviewLanguage parameter to Reviews: List requests in the Knowledge API

June 26

  • Added the flagStatus field to the Review data model

June 25

June 20

  • Added the sourceUrl field to the Photo data model

MAY

May 17

  • Added the following to the Analytics: Create Report endpoint in the Knowledge API:
    • EVENT_SEARCHES, EVENT_PROFILEVIEWS, TICKET_CLICKS, ST_EVENT_SHARE_OF_INTELLIGENT_SEARCH, ST_EVENT_RICH_RESULT_PRESENCE, and ST_EVENT_MATCHES_PER_SEARCH values to metrics
    • ENTITY_IDS, ENTITY_TYPES, ENTITY_GROUPS, EVENTS, and EVENT_SEARCH_CONDITION values to dimensions
    • entityIds, entityType, entityGroup, eventSearchCondition filters

APRIL

April 9

  • Added IST_TOTAL_MATCHES value to metrics and IST_LOCAL_PACK_COMPETITOR value to dimensions in the Analytics: Create Report endpoint in the Knowledge API

April 3

  • Added flagStatus field to Review: Update requests in the Knowledge API

MARCH

March 15

  • Added actionable field to Listings: List response in the Knowledge API

March 14

March 8

  • Added all macro compatibility to Listings: List requests in the Knowledge API

March 7

  • Changed the behavior of schemaType field in Location data model to be read-only

March 2

FEBRUARY

February 23

February 2

  • Added the following filter options to Locations: List and Locations: GeoSearch requests in the Live API:
    • alternateProfileLanguage
    • lastUpdated
    • fieldsWithData
    • fieldsWithoutData
    • reviewCount
    • averageRating
    • notInFolder
    • locationType
    • gender
    • degrees
    • experiences
    • yearCompleted
    • acceptingNewPatients
    • firstName
    • middleName
    • lastName
    • officeName
    • certifications
    • institutionName
    • insuranceAccepted
    • admittingHospitals
    • subscriptions
    • facebookAccounts
    • foursquareAccounts
    • googleplusAccounts
    • labels

JANUARY

January 30

  • Added the following fields to the Location data model:
    • attire
    • priceRange
    • locatedIn

January 24

January 23

January 11

January 2

Back to top

2017

DECEMBER

December 14

  • Added the following fields to the Location data model:
    • primaryContact
    • reviewResponseConversationEnabled
    • holidayHoursConfirmationEnabled
  • Added sourceUrl field to Menu data model

December 5

NOVEMBER

November 13

  • Listings: List responses in the Knowledge API are now sorted first by publisherId, then by locationId. Previously, they were were sorted first by locationId, then by publisherId.

November 8

OCTOBER

October 2

Back to top

BACKWARD-INCOMPATIBLE CHANGES

API features that are affected by the use of a specific v parameter are described below.

February 25, 2019

Availability of displayLanguagePreference and emailLanguagePreference fields in the User data model
  • Available only if the v parameter is 20190225 or later.

January 11, 2019

Availability of supportedLocationTypes and supportedEntityTypes field in the Publisher data model
  • If the v parameter is before 20190111: supportedLocationTypes is available, supportedEntityTypes is not
  • If the v parameter is 20190111 or later: supportedEntityTypes is available, supprotedLocationTypes is not

January 3, 2019

Contents of alternate Language Profiles across API responses
  • If the v parameter is before 20190103: by default, returned alternate Language Profiles include googleAttributes and categoryIds fields
  • If the v parameter is 20190103 or later: by default, returned alternate Language Profiles do not include googleAttributes and categoryIds fields. However, these fields can still be retrieved if the rendered parameter in the request is set to true.

December 4, 2018

Data type of folderId in Entities: Create and Entities: Update requests
  • If the v parameter is before 20181204: assigned or updated folderId values should be numbers
  • If the v parameter is on or after 20181204: assigned or updated folderId values should be strings
Formatting of googleAttributes values in Entity data models
  • If the v parameter is before 20181204: the contents are formatted as a map of key-value pairs (e.g., [{ “id”: “has_wheelchair_accessible_entrance”, “values”: [ “true” ] }])
  • If the v parameter is on or after 20181204: the contents are formatted as a list of objects (e.g., { “has_wheelchair_accessible_entrance”: [ “true” ]}

November 29, 2018

Contents of Entities: Create responses
  • If the v parameter is before 20181129: the 201 response contains the created Entity’s id
  • If the v parameter is on or after 20181129: the 201 response contains the created Entity in its entirety

October 2, 2018

Availability of reviewType and recommendation fields in Review data model
  • Available only if the v parameter is 20181002 or later.
Availability of reviewType and recommendation parameters in Reviews: List requests
  • Available only if the v parameter is 20181002 or later.

August 9, 2018

Contents of Custom Fields: List and Custom Field: Get responses:
  • If the v parameter is before 20180809:
    • id contains the Custom Field’s numeric ID, which can be used to refer to the Custom Field in Location endpoints
    • The key subfield of option contains the option’s numeric ID, which can be used to refer to the option in Location endpoints
    • LOCATION_LIST is a valid value of type, and ENTITY_LIST is not
  • If the v parameter is 20180809 or later:
    • id contains the Custom Field’s ID as a string, which can be used to refer to the Custom Field in Entity endpoints
    • The key subfield of option contains the option’s ID as a string, which be used to refer to the option in Entity endpoints
    • ENTITY_LIST is a valid value of type, and LOCATION_LIST is not

August 2, 2018

Contents of Duplicates: List responses
  • If the v parameter is before 20180802: by default, all duplicates will be included in the response
  • If the v parameter is 20180802 or later: by default, only duplicates of live listings (status: LIVE) will be included in the response

July 10, 2018

Availability of labelIds in Review data model
  • Available only if the v parameter is before 20180710.
Availability of reviewLabels in Review data model
  • Available only if the v parameter is 20180710 or later.

March 14, 2018

Behavior of endDate filter in Analytics: Create Report requests
  • If the v parameter is on or after 20180314: endDate is the exclusive end date for the report data. Must be after the date specified in the startDate filter.
  • If the v parameter is before 20180314: endDate is the inclusive end date for the report data. Must be on or before the date specified in the startDate filter.

February 23, 2018

Behavior of labelIds field in Locations: Update requests
  • If the v parameter is before 20180223: setting the value of labelIds to an empty array has no effect on the current value
  • If the v parameter is 20180223 or after: setting the value of labelIds to an empty array deletes the current value

December 4, 2017

Availability of KEYWORD_SENTIMENT and KEYWORD_MENTIONS metrics and REVIEW_KEYWORDS dimension in Analytics: Create Report requests
  • Available only if the v parameter is 20171204 or later.

October 20, 2017

Behavior of GOOGLE_QUERY_TYPE dimension in Analytics: Create Report requests
  • If the v parameter is before 20171020: query groupings are BRANDED and UNBRANDED.
  • If the v parameter is 20171020 or later: query groupings are DIRECT and DISCOVERY.

September 14, 2017

Availability of YELP_CUSTOMER_ACTIONS metric and CUSTOMER_ACTION_TYPE dimension in Analytics: Create Report requests
  • Available only if the v parameter is 20170914 or later
  • CUSTOMER_ACTION_TYPE dimension replaces GOOGLE_ACTION_TYPE dimension
Availability of GOOGLE_ACTION_TYPE dimension in Analytics: Create Report requests
  • Available only if the v parameter is before 20170914

September 1, 2017

Availability of pageToken parameter in Reviews: List requests
  • Available only if the v parameter is 20170901 or later
Availability of nextPageToken field in Reviews: List response
  • Available only if the v parameter is 20170901 or later

August 30, 2017

Availability of status parameter in Reviews: List requests
  • Available only if the v parameter is 20170830 or later

June 17, 2017

Behavior of minPublisherDate, maxPublisherDate, minLastYextUpdateDate, and maxLastYextUpdateDate parameters in Reviews: List requests
  • If the v parameter is before 20170617: parameter values assumed to be in Eastern Standard Time (EST)
  • If the v parameter is 20170617 or later: parameter values assumed to be in Coordinated Universal Time (UTC)

May 12, 2017

Contents of lastYextUpdateTime field in Reviews: List, Review: Get, and Reviews Webhook responses
  • If the v parameter is before 20170512: the timestamp of the review (including listing updates)
  • If the v parameter is 20170512 or later: the timestamp of the review (excluding listing updates), or the timestamp of the latest comment on the review

April 20, 2017

Contents of count field in Listings: List responses
  • If the v parameter is before 20170420: the Listings count, including alternate brands
  • If the v parameter is 20170420 or later: the Listings count, excluding alternate brands
Availability of alternateBrands field in Listings: List responses
  • Available only if the v parameter is 20170420 or later
Back to top