Compartilhar via


Yelp (Independent Publisher) (Preview)

The Yelp connector allows you to get the best local content, points of interest, and user reviews from millions of businesses across 32 countries.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Ahmad Najjar
Email ahmadn82@hotmail.com
Connector Metadata
Publisher Ahmad Najjar
Website https://www.yelp.com/
Privacy policy https://terms.yelp.com/privacy/

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Yelp API Key securestring Provide a Yelp API key as 'Bearer API_KEY' True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Autocomplete

Provide autocomplete suggestions for businesses, search keywords and categories.

Find Business Match

Find the Yelp business that matches an exact input location. Use this action to match business data from other sources with Yelp businesses.

Get Business Details

Get rich business data, such as name, address, phone number, photos, Yelp rating, price levels and hours of operation.

Get Reviews

Get up to three review excerpts for a business.

Search Business Phones

Returns a list of businesses based on the provided phone number. Use this action when you only have the phone number or less confident about other matching criteria.

Search Businesses

Search for businesses by Term (keyword), category, location, price level, etc. Use this action when you have general info on the biz like name & location but don't know the address.

Autocomplete

Provide autocomplete suggestions for businesses, search keywords and categories.

Parameters

Name Key Required Type Description
Text
text True string

Text to return autocomplete suggestions for.

Latitude
latitude True double

Required if want to get autocomplete suggestions for businesses. Latitude of the location to look for business autocomplete suggestions.

Longitude
longitude True double

Required if want to get autocomplete suggestions for businesses. Longitude of the location to look for business autocomplete suggestions.

Locale
locale string

Default en_US. (See https://bit.ly/3lwvIWU)

Returns

Name Path Type Description
terms
terms array of object

terms

text
terms.text string

text

businesses
businesses array of object

businesses

name
businesses.name string

name

id
businesses.id string

id

text
businesses.text string

text

categories
categories array of object

categories

alias
categories.alias string

alias

title
categories.title string

title

Find Business Match

Find the Yelp business that matches an exact input location. Use this action to match business data from other sources with Yelp businesses.

Parameters

Name Key Required Type Description
Name
name True string

The name of the business. Maximum length is 64; only digits, letters, spaces, and !#$%&+,�./:?@'are allowed.

Address 1
address1 True string

The first line of the business�s address. Maximum length is 64; only digits, letters, spaces, and ��/#&,.: are allowed. The empty string "" is allowed; this will specifically match certain service businesses that have no street address.

Address 2
address2 string

The second line of the business�s address. Maximum length is 64; only digits, letters, spaces, and ��/#&,.: are allowed.

Address 3
address3 string

The third line of the business�s address. Maximum length is 64; only digits, letters, spaces, and ��/#&,.: are allowed.

City
city True string

The city of the business. Maximum length is 64; only digits, letters, spaces, and ��.() are allowed.

State
state True string

The ISO 3166-2 (with a few exceptions) state code of this business. Maximum length is 3.

Country
country True string

The ISO 3166-1 alpha-2 country code of this business. Maximum length is 2.

Latitude
latitude double

The WGS84 latitude of the business in decimal degrees. Must be between �-90 and +90.

Longitude
longitude double

The WGS84 longitude of the business in decimal degrees. Must be between �-180 and +180.

Phone
phone string

The phone number of the business which can be submitted as (a) locally �formatted with digits only (e.g., 016703080) or (b) internationally� formatted with a leading + sign and digits only after (+35316703080). Maximum length is 32.

Zip Code
zip_code string

The Zip code of this business.

Yelp Business ID
yelp_business_id string

Unique Yelp identifier of the business if available. Used as a hint when finding a matching business.

Limit
limit integer

Maximum number of business results to return. By default, it will return 3. Minimum is 1, maximum is 10.

Match Threshold
match_threshold integer

Specifies whether a match quality threshold should be applied to the matched businesses. Must be one of 'none', 'default' or 'strict'. none: Do not apply any match quality threshold; all potential business matches will be returned. default: Apply a match quality threshold such that only very closely matching businesses will be returned. strict: Apply a very strict match quality threshold.

Returns

Name Path Type Description
array of object
name
name string

name

address1
location.address1 string

address1

address2
location.address2 string

address2

address3
location.address3 string

address3

city
location.city string

city

state
location.state string

state

zip_code
location.zip_code string

zip_code

country
location.country string

country

latitude
coordinates.latitude float

latitude

longitude
coordinates.longitude float

longitude

phone
phone string

phone

id
id string

id

alias
alias string

alias

Get Business Details

Get rich business data, such as name, address, phone number, photos, Yelp rating, price levels and hours of operation.

Parameters

Name Key Required Type Description
ID
id True string

Unique Yelp ID of this business.

Locale
locale string

Default en_US. (See https://bit.ly/3lwvIWU)

Returns

Name Path Type Description
id
id string

id

alias
alias string

alias

name
name string

name

image_url
image_url string

image_url

is_claimed
is_claimed boolean

is_claimed

is_closed
is_closed boolean

is_closed

url
url string

url

phone
phone string

phone

display_phone
display_phone string

display_phone

review_count
review_count integer

review_count

categories
categories array of object

categories

alias
categories.alias string

alias

title
categories.title string

title

rating
rating float

rating

address1
location.address1 string

address1

address2
location.address2 string

address2

address3
location.address3 string

address3

city
location.city string

city

zip_code
location.zip_code string

zip_code

country
location.country string

country

state
location.state string

state

display_address
location.display_address array of string

display_address

cross_streets
location.cross_streets string

cross_streets

latitude
coordinates.latitude float

latitude

longitude
coordinates.longitude float

longitude

photos
photos array of string

photos

price
price string

price

hours
hours array of object

hours

open
hours.open array of object

open

is_overnight
hours.open.is_overnight boolean

is_overnight

start
hours.open.start string

start

end
hours.open.end string

end

day
hours.open.day integer

day

hours_type
hours.hours_type string

hours_type

is_open_now
hours.is_open_now boolean

is_open_now

transactions
transactions array of

transactions

special_hours
special_hours array of object

special_hours

date
special_hours.date string

date

is_closed
special_hours.is_closed string

is_closed

start
special_hours.start string

start

end
special_hours.end string

end

is_overnight
special_hours.is_overnight boolean

is_overnight

Get Reviews

Get up to three review excerpts for a business.

Parameters

Name Key Required Type Description
ID
id True string

Unique Yelp ID of this business.

Locale
locale string

Default en_US. (See https://bit.ly/3lwvIWU)

Returns

Name Path Type Description
reviews
reviews array of object

reviews

id
reviews.id string

id

rating
reviews.rating integer

rating

id
reviews.user.id string

id

profile_url
reviews.user.profile_url string

profile_url

image_url
reviews.user.image_url string

image_url

name
reviews.user.name string

name

text
reviews.text string

text

time_created
reviews.time_created string

Time created

url
reviews.url string

url

total
total integer

total

possible_languages
possible_languages array of string

Possible languages

Search Business Phones

Returns a list of businesses based on the provided phone number. Use this action when you only have the phone number or less confident about other matching criteria.

Parameters

Name Key Required Type Description
Phone
phone True string

Phone number of the business you want to search for. (like +14159083801)

Locale
locale string

Default en_US. (See https://bit.ly/3lwvIWU)

Returns

Name Path Type Description
total
total integer

total

businesses
businesses array of object

businesses

rating
businesses.rating float

rating

price
businesses.price string

price

phone
businesses.phone string

phone

id
businesses.id string

id

alias
businesses.alias string

alias

categories
businesses.categories array of object

categories

alias
businesses.categories.alias string

alias

title
businesses.categories.title string

title

review_count
businesses.review_count integer

review_count

name
businesses.name string

name

url
businesses.url string

url

latitude
businesses.coordinates.latitude float

latitude

longitude
businesses.coordinates.longitude float

longitude

image_url
businesses.image_url string

image_url

is_closed
businesses.is_closed boolean

is_closed

city
businesses.location.city string

city

country
businesses.location.country string

country

address2
businesses.location.address2 string

address2

address3
businesses.location.address3 string

address3

state
businesses.location.state string

state

address1
businesses.location.address1 string

address1

zip_code
businesses.location.zip_code string

zip_code

transactions
businesses.transactions array of string

transactions

Search Businesses

Search for businesses by Term (keyword), category, location, price level, etc. Use this action when you have general info on the biz like name & location but don't know the address.

Parameters

Name Key Required Type Description
Term (Keyword)
term True string

Search term, for example "restaurants". The term may also be business names.

Location
location True string

The geographic area used when searching for businesses. E.g. New York, NYC

Latitude
latitude double

Latitude of the location you want to search nearby.

Longtitude
longtitude double

Longitude of the location you want to search nearby.

Radius
radius integer

A suggested search radius in meters. (Max: 40000 m)

Categories
categories string

(See https://bit.ly/3jnraj5)

Locale
locale string

Default en_US. (See https://bit.ly/3lwvIWU)

Limit
limit integer

Number of business results to return. Default (20). Max (50)

Offset
offset integer

Offset the list of returned business results by this amount.

Sort by
sort_by string

Suggestion to the search algorithm that the results be sorted by.

Open Now
open_now boolean

(Default=false). When set to true, only return the businesses open now.

Returns

Name Path Type Description
Total
total integer

Total number of business Yelp finds based on the search criteria. Sometimes, the value may exceed 1000. In such case, you still can only get up to 1000 businesses using multiple queries and combinations of the "limit" and "offset" parameters.

businesses
businesses array of object

List of business Yelp finds based on the search criteria.

Rating
businesses.rating float

Rating for this business (value ranges from 1, 1.5, ... 4.5, 5).

Price
businesses.price string

Price level of the business. Value is one of $, $$, $$$ and $$$$.

Phone
businesses.phone string

Phone number of the business.

ID
businesses.id string

Unique Yelp ID of this business.

Alias
businesses.alias string

Unique Yelp alias of this business. Can contain unicode characters. Example: "yelp-san-francisco"

Is Closed
businesses.is_closed boolean

Whether business has been (permanently) closed

categories
businesses.categories array of object

List of category title and alias pairs associated with this business.

alias
businesses.categories.alias string

Alias of a category, when searching for business in certain categories, use alias rather than the title.

title
businesses.categories.title string

Title of a category for display purpose.

Review Count
businesses.review_count integer

Number of reviews for this business.

Name
businesses.name string

Name of this business.

URL
businesses.url string

URL for business page on Yelp.

Latitude
businesses.coordinates.latitude float

Latitude of this business.

Longitude
businesses.coordinates.longitude float

Longitude of this business.

Image URL
businesses.image_url string

URL of photo for this business.

City
businesses.location.city string

City of this business

Country
businesses.location.country string

Country code of this business. (ISO 3166-1 alpha-2)

Address 2
businesses.location.address2 string

Street address of this business, continued.

Address 3
businesses.location.address3 string

Street address of this business, continued.

State
businesses.location.state string

State code of this business. ISO 3166-2 (with a few exceptions)

Address 1
businesses.location.address1 string

Street address of this business.

Zip Code
businesses.location.zip_code string

Zip code of this business.

Distance
businesses.distance float

Distance in meters from the search location. This returns meters regardless of the locale.

transactions
businesses.transactions array of string

List of Yelp transactions that the business is registered for. Current supported values are pickup, delivery and restaurant_reservation.

Latitude
region.center.latitude double

Latitude position of map bounds center.

Longitude
region.center.longitude double

Longitude position of map bounds center.