API Change Log

2018

APRIL

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, 2017

Back to top

BACKWARD-INCOMPATIBLE CHANGES

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

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

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

Content 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

Content 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