> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Yelp Reporting Connector

## Intro

Yelp is a local business directory service and review site with social networking features. To learn more about the Yelp Reporting API, visit their page ([https://www.yelp.com/developers](https://www.yelp.com/developers)).

You connect to your Yelp Reporting account in the Data Center. This topic discusses the fields and menus that are specific to the Yelp Reporting connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274).

## Prerequisites

To connect to your Yelp account and create a dataset, you must have your Yelp Reporting API username and password. This username and password is different from your standard Yelp login. To request your credentials, please reach out to your Yelp sales representative. Your Yelp sales representative will create the credentials and share them with you.

## Connecting to Your Yelp Reporting Account

This section enumerates the options in the **Credentials** and **Details** panes in the Yelp Reporting Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Yelp account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Username </p></td><td colspan="1" rowspan="1"><p> Enter your Yelp username. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Password </p></td><td colspan="1" rowspan="1"><p> Enter your Yelp password. </p></td></tr></tbody></table>

Once you have entered valid Yelp credentials, you can use the same account any time you go to create a new Yelp Reporting DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Yelp Reporting report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p> Daily Report </p></td><td colspan="1" rowspan="1"><p> Returns a report containing daily business/advertiser metrics for specified Business IDs over a date range. You can request daily data for up to the last 2 months for Business Metrics and up to the last 12 months for Advertiser Metrics. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Monthly Report </p></td><td colspan="1" rowspan="1"><p> Returns a report containing monthly business/advertiser metrics for specified Business IDs over a date range. You can request monthly data for up to the last 12 months for all metrics in monthly reports. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Business IDs </p></td><td colspan="1" rowspan="1"><p> Enter a comma-separated list of IDs of the businesses you want to retrieve data for. You can find business IDs by running the "Search" report in the Yelp connector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Business and Advertising Metrics </p></td><td colspan="1" rowspan="1"><p> Select the business and advertising metrics you want to see in your report. </p><p><b> Business Metrics </b></p><p> For daily reports, you can request business metrics for the last 2 months. For monthly reports, you can request metrics for the last year. </p><table class="mt-responsive-table"><thead><tr><th colspan="1" rowspan="1"><p> Metric </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Calls Tracked </p></td><td colspan="1" rowspan="1"><p> Number of calls tracked. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Clicks to Website </p></td><td colspan="1" rowspan="1"><p> Number of clicks to the business URL from the Yelp business profile. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deals Sold </p></td><td colspan="1" rowspan="1"><p> Number of deals sold. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Desktop Appearances in Search </p></td><td colspan="1" rowspan="1"><p> Number of times a business appeared in a search on desktop devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Desktop Call-to-Action Clicks </p></td><td colspan="1" rowspan="1"><p> Number of Call-to-Action clicks on desktop devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Desktop User Views </p></td><td colspan="1" rowspan="1"><p> Number of page views on desktop devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Direction & Map Views </p></td><td colspan="1" rowspan="1"><p> Number of direction and map views from the Yelp business profile. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Mobile Appearances in Search </p></td><td colspan="1" rowspan="1"><p> Number of times a business appeared in search on mobile devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Mobile Call-to-Action Clicks </p></td><td colspan="1" rowspan="1"><p> Number of Call-to-Action clicks on mobile devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Mobile Calls </p></td><td colspan="1" rowspan="1"><p> Number of phone calls initiated from the Yelp business profile. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Mobile Check-Ins </p></td><td colspan="1" rowspan="1"><p> Number of mobile check-ins from the Yelp business profile. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Mobile User Views </p></td><td colspan="1" rowspan="1"><p> Number of page views on mobile devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Online Bookings </p></td><td colspan="1" rowspan="1"><p> Number of online bookings. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Online Orders </p></td><td colspan="1" rowspan="1"><p> Number of online orders. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Request a Quote Messages </p></td><td colspan="1" rowspan="1"><p> Number of messages sent to a business including messages sent through Request a Quote. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Total User Views </p></td><td colspan="1" rowspan="1"><p> Number of total page views on desktop and mobile devices. </p></td></tr><tr><td colspan="1" rowspan="1"><p> User Uploaded Photos </p></td><td colspan="1" rowspan="1"><p> Number of user-generated photos added to the Yelp business profile. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Yelp Bookmarks </p></td><td colspan="1" rowspan="1"><p> Number of times a business has been bookmarked by users. </p></td></tr></tbody></table><p /><p><b> Advertiser Metrics </b></p><p> For both daily and monthly reports, you can request advertiser metrics for up to 1 year ago. </p><p /><table class="mt-responsive-table"><thead><tr><th colspan="1" rowspan="1"><p> Metric </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1"><p> Ad Cost </p></td><td colspan="1" rowspan="1"><p> Cost of ad. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Clicks to Website </p></td><td colspan="1" rowspan="1"><p> Number of clicks to the business URL from the Yelp business profile that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Deals Sold </p></td><td colspan="1" rowspan="1"><p> Number of deals sold that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Directions and Map Views </p></td><td colspan="1" rowspan="1"><p> Number of direction and map views from the Yelp business profile that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Mobile Calls </p></td><td colspan="1" rowspan="1"><p> Number of phone calls initiated from the Yelp business profile that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Mobile Check-ins </p></td><td colspan="1" rowspan="1"><p> Number of mobile check-ins from the Yelp business profile that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Online Reservations </p></td><td colspan="1" rowspan="1"><p> Number of Yelp Reservations and Yelp No-Wait bookings that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Request-a-Quote Messages </p></td><td colspan="1" rowspan="1"><p> Number of messages sent to a business including messages sent through Request a Quote that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Total Call-to-Action Clicks </p></td><td colspan="1" rowspan="1"><p> Number of Call-to-Action clicks on desktop devices that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN User-Uploaded Photos </p></td><td colspan="1" rowspan="1"><p> Number of user-generated photos added to the Yelp business profile that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AD-DRIVEN Yelp Bookmarks </p></td><td colspan="1" rowspan="1"><p> Number of times a business has been bookmarked by users that can be attributed to an Ad impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Billed Ad Clicks </p></td><td colspan="1" rowspan="1"><p> Number of clicks from a billed impression. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Billed Ad Impressions </p></td><td colspan="1" rowspan="1"><p> Number of times Ad is displayed and will be billed. </p></td></tr></thead></table><p /></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><p> Select whether you want to pull data for a specific date or a date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> Select whether the report data is for a specific date or for a relative number of days back from today. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the date for the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back </p></td><td colspan="1" rowspan="1"><p> Enter the number of past days that should appear in the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Days Back to End At </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to End At </p></td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day back that should be represented in the report. Combine with <b> Days Back to Start From </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Data Connector](/s/article/360042926274).

## FAQs

<AccordionGroup>
  <Accordion title="How can I find the ID for the business I want to retrieve data for?">
    You can find IDs for specific businesses by running the "Search" report in the standard Yelp connector.
  </Accordion>
</AccordionGroup>
