Yelp API endpoint
Fetches thematic review snippets (extracted talking points with a supporting quote) for a Yelp business.
/yelp/business/{id}/reviews/highlightsPath parameters: id is required and accepts a Yelp business alias (e.g. pequods-pizza-chicago-3) or an encoded Yelp business id.
Returns Yelp's extracted review "highlights" — recurring talking points (e.g. "crispy", "caramelized cheese") each with a representative supporting quote (HTML-highlighted) and how many reviews mention it. This is distinct from Yelp Business Reviews: it's a thematic summary, not a page of full review text.
| Field | Filled in, of 5 checked | Values in the sample |
|---|---|---|
| identifier | 5 | |
| sentence_html | 5 | median 123 characters |
| review_count | 5 | 95 to 409, median 104 |
| review_id | 5 | |
| photo_url | 5 | s3-media0.fl.yelpcdn.com |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| id (path) | string | Yes | Yelp business alias or encoded id | pequods-pizza-chicago-3 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/yelp/business/pequods-pizza-chicago-3/reviews/highlights" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"id": "pequods-pizza-chicago-3",
"total": 5,
"highlights": [
{
"identifier": "caramelized_cheese",
"sentence_html": "The <b>caramelized cheese</b> on the edges of the pizza is what really distinguishes this pizza from other places.",
"review_count": 100,
"review_id": "L1DgWzEs-KXpTevIF9FnZQ",
"photo_url": "https://s3-media0.fl.yelpcdn.com/bphoto/9qUtWwjuKzQnj6-39Es_6A/ms.jpg"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/yelp.mobileBusinessReviewHighlightsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | yelp.MobileBusinessReviewHighlightsResponse | No | ||||
| data.highlights | array | No | ||||
| data.highlights[].identifier | string | No | ||||
| data.highlights[].photo_url | string | No | ||||
| data.highlights[].review_count | integer | No | ||||
| data.highlights[].review_id | string | No | ||||
| data.highlights[].sentence_html | string | No | ||||
| data.id | string | No | pequods-pizza-chicago-3 | |||
| data.total | integer | No | 5 | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/yelp/business/pequods-pizza-chicago-3/reviews/highlights" \
-H "x-api-key: $CRAWLORA_API_KEY"