Skip to content

▪ Ratings

Pricing Tier Licence Type

Ratings API returns data based on numerical evaluations left by users for a POI.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/poi/{poi_id}/ratings

Path Parameters

Name                       Description Type Examples
*{billing_plan} Billing plan to be applied to the call. string licence
ondemand
*{account_id} Provided identifier of the account. string
*{poi_id} Identifier of the POI to retrieve data for.
Value obtainable either :
- if {billing_plan}= licence, from $.results[*].resource.id field of List Licences Response Body
- if {billing_plan}= ondemand, from $.results.pois[*].id field of any Search API Response Body.		 string XXeUNbmtYZTsH7UGvNfXWo

Header Parameters

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
*from Start date of timeframe. date 2020-01-01
*to End date of timeframe. date 2020-12-31
reply_received Filter by contents with a reply. boolean true
false
ⓝ network Filter by network. string Dictionary
ⓝ user_country Filter by reviewer's country of origin in ISO 3166-1 alpha-2 standard format (in lower case). string it
de
ⓝ content_language Filter by contents language in ISO_639-1 standard format. string en
fr
ⓝ user_type Filter by user type. string Dictionary
Example 
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/HF8xjSQW4W43NGr56denSh/ratings?from=2020-01-01&to=2020-02-29' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Ratings data has been successfully returned.

Body

Ratings

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": 590
    },
    "rating": {
        "average": 7.37,
        "cap": 10
    }
}