Skip to content

▪ Overall Series

Pricing Tier Licence Type

Overall Series API returns a time-based overall data series for the selected POI, grouped by a time period.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/poi/{poi_id}/overall/series

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
*period Time unit of the series. string day
week
month
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
Supported values for period
  • day
  • week
  • month
Example 
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/HF8xjSQW4W43NGr56denSh/overall/series?from=2020-01-01&to=2020-02-29&period=month&page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Overall Series data has been successfully returned.

Body

SeriesOverall

Field Description Type
series Overall Series data for the requested timeframe and period. array[SeriesOverallElement]
SeriesOverallElement
Field Description Type
*period Date representing the requested period, corresponding to the first day of the period.
day: the day itself.
week: first day of the corresponding week.
month: first day of the corresponding month.		 date
*value Overall grouped data of corresponding period. Overall
Overall
Field Description Type
sentiment KPI which indicates users global satisfaction. PolarizedValue
contents Total and grouped by polarity count of contents. PolarizedCount
PolarizedValue
Field Description Type Examples
value Value of the including field in the range [0,100]. decimal 60.3
59.7
polarity Polarity of the corresponding value. string POSITIVE
NEGATIVE
PolarizedCount
Field Description Type
positive Positive elements count. int
negative Negative elements count. int
neutral Neutral elements count. int
total Total elements count. int
Example 
{
    "series": [
        {
            "period": "2020-01-01",
            "value": {
                "sentiment": {
                    "value": 79.36,
                    "polarity": "POSITIVE"
                },
                "contents": {
                    "positive": 266,
                    "negative": 50,
                    "neutral": 0,
                    "total": 316
                }
            }
        },
        {
            "period": "2020-02-01",
            "value": {
                "sentiment": {
                    "value": 74.07,
                    "polarity": "POSITIVE"
                },
                "contents": {
                    "positive": 206,
                    "negative": 68,
                    "neutral": 0,
                    "total": 274
                }
            }
        }
    ]
}