▪ Ratings
Ratings API returns data based on numerical evaluations left by users for POIs within a specified {Location}
.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/locations/ratings
Path Parameters
Name |
Description |
Type |
Examples |
*{billing_plan} |
Billing plan to be applied to the call. |
string |
ondemand |
*{account_id} |
Provided identifier of the account. |
string |
|
/sample |
Filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location). |
string |
|
/sample
optional path parameter
Inserting optional path parameter /sample
in the following position:
will filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location).
Name |
Description |
Type |
Examples |
*x-api-key |
Provided API key {x_api_key} that allows authentication. |
string |
|
*Authorization |
Provided token {jwt_bearer} that allows authorization. |
string |
Bearer {jwt_bearer} |
Query Parameters
Name |
Description |
Type |
Examples |
Default |
*{Location} |
Location identifier. |
Geospatial |
AreaGeometryIDCircle |
|
*from |
Start date of timeframe. |
date |
2020-01-01 |
|
*to |
End date of timeframe. |
date |
2020-12-31 |
|
ⓝ network |
Filter by network. |
string |
Dictionary |
|
ⓝ poi_class |
Filter POIs with "category": "hotel" by stars rating in the range [1,5]. |
int |
4 |
|
ⓝ poi_industry |
Filter by POI Industry. |
string |
Dictionary |
|
ⓝ poi_category |
Filter by POI Category. |
string |
Dictionary |
|
ⓝ user_type |
Filter by reviewer type. |
string |
Dictionary |
|
ⓝ user_country |
Filter by reviewer's country of origin in ISO 3166-1 alpha-2 standard format (in lower case). |
string |
itde |
|
ⓝ content_language |
Filter by contents language in ISO_639-1 standard format. |
string |
enfr |
|
ⓝ content_type |
Filter by type of content. |
string |
postreviewtaggedpost |
review && taggedpost |
Supported values for content_type
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/ratings?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Example /sample
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/sample/ratings?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Response
Status
Status |
Description |
200 |
Ratings data has been successfully returned. |
Body
LocationRatings
Field |
Description |
Type |
contents |
Total count of contents. |
Total |
rating |
Average rating score. |
AverageCap |
Total
Field |
Description |
Type |
total |
Total count of elements. |
int |
AverageCap
Field |
Description |
Type |
average |
Average value in the range [0,cap ]. |
decimal |
cap |
Max possible value. |
int |
Example
{
"contents": {
"total": 181223
},
"rating": {
"average": 8.88,
"cap": 10
}
}