Yelp

Before Getting Started

To get started with the Yelp datasource, ensure you have the following:

Yelp Fusion API uses private API Keys to authenticate requests, there are only 2 steps:

Yelp recommends customers share API tokens to preserve data hygiene and visibility.

Any customer specific API tokens should be shared in 1Password or a similar method if needed to create multiple data sources.

1. If you client does not already have an API key, create an app to obtain your private API Key.

2. Get Yelp Reporting API access for this API key from the Yelp team.

3. Authenticate by providing the API Key in the "Additional Configuration" section required for the datasource.

Create an app on Yelp's Developers site

In order to set up your access to Yelp Fusion API, you need to create an app with Yelp. This app represents the application you'll build using our API and includes the credentials you'll need to gain access. Here are the steps for creating an app:

1. Go to Create App

2. In the create new app form, enter information about your app, then agree to Yelp API Terms of Use and Display Requirements. Then click the Submit button.

3. You will now have an API Key.

See Fusion Authentication for more details.

Yelp Reporting API access

1. Once App created , send the client_id to Yelp team

2. Yelp configures that client ID with reporting API v3 access.

Any accounts that want to be enabled for Yelp Reporting API access should be routed through @Elizabeth Bercovich @Michelle Paul &  @Happy Sandhu 

Authenticate Datasource

Once the client ID has been configured for access to the Yelp reporting API, provide the corresponding API Key to facilitate data loading on datasource.

Processing Time for Report

Yelp metrics are batch processed once every 24 hours. Each analytics run captures one day of data (starting and ending at midnight PST). Advertiser Metrics are usually complete by 10:00 AM PST the following day. Once metrics are available in Reporting API, they do not change.

There may be more than a 24-hour lag between delivery and reporting (e.g. if an ad is delivered at 12:01AM on Monday and yelp analytics run completes at 10AM on Tuesday). The batch itself runs every day. User can  select backfill dates to load the data.

A report usually takes 30 minutes to process and load the data.

5 QPS(Query Per Second) for the business details report, if you need more, reach out to yelp team and they can push an exception for you. 20 is the highest.

Campaign Names

The campaign and program names are not currently available in the yelp reporting API. Each unique CPC program is represented by a program_id in the reporting but yelp don't expose the names.

Separately we can request yelp to send a csv that has the mapping of program_id to campaign_id and name so you could join as a separate data source, but that's not available programmatically via api.

Additional Configurations

API Key

Enter API Key.

Business Id’s

Enter business ids. (reach out to yelp team for a list of all business ids of a client)

Frequently Asked Questions

What authentication method does the API employ, and what specific key is utilized for authentication purposes?

The API uses your Yelp Fusion Api Key for authentication. See Fusion Authentication for details.

How can one retrieve data after making a report request, and what is the typical processing time for a report?

When a request is made for a report, a corresponding report ID will be returned. The report ID can then be used to retrieve data for the requested set of metrics across the requested set of businesses. A report usually takes 30 minutes to process.

Why does the API currently exclude businesses that do not have any reviews when returning data?

at this time, the Business Details API does not return businesses without any reviews.

campaign name/program name, is this available through the Yelp Reporting API?

The campaign and program names are not currently available in the reporting API. Each unique CPC program is represented by a program_id in the reporting but yelp don't expose the names.

Separately we can request yelp to send a csv that has the mapping of program_id to campaign_id and name so you could join as a separate data source, but that's not available programmatically via api.

Could you please provide information on the queries-per-second limit for BusinessDetails endpoint?

5 QPS for the business details report, if you need more, reach out to yelp team and they can push an exception for you. 20 is the highest yelp be able to go.