Skip to content

▪ Rating Series

Rating Series API returns a time-based rating data series for the specified {Location}, grouped by a time period.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/ratings/series

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:

  • /v4/{billing_plan}/account/{account_id}/locations/sample/…

will filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location).

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 Default
*{Location} Location identifier. Geospatial Area
GeometryID
Circle
*from Start date of timeframe. date 2020-01-01
*to End date of timeframe. date 2020-12-31
*period Time unit of the series. string week
month
ⓝ 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 it
de
ⓝ content_language Filter by contents language in ISO_639-1 standard format. string en
fr
ⓝ content_type Filter by type of content. string post
review
taggedpost		 review && taggedpost
Supported values for period
  • week
  • month
Supported values for content_type
  • review
  • post
  • taggedpost
Example 
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/ratings/series?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&period=month' \
-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/series?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&period=month' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Rating Series data has been successfully returned.

Body

LocationSeriesRatings

Field Description Type
series Rating Series data for the requested timeframe and period. array[LocationSeriesRatingsElement]
LocationSeriesRatingsElement
Field Description Type
*period Date representing the requested period, corresponding to the first day of the period.
week: first day of the corresponding week.
month: first day of the corresponding month.		 date
*value Ratings data of corresponding period. LocationRatings
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 
{
    "series": [
        {
            "period": "2021-01-01",
            "value": {
                "contents": {
                    "total": 15723
                },
                "rating": {
                    "average": 8.88,
                    "cap": 10
                }
            }
        },
        {
            "period": "2021-02-01",
            "value": {
                "contents": {
                    "total": 16514
                },
                "rating": {
                    "average": 8.86,
                    "cap": 10
                }
            }
        }
    ]
}