▪ Overall Compare
Overall Compare API returns overall data for the selected POI for two different timeframes at once: one defined by [from,to] query parameters and another auto-calculated for the same duration in the past.
Additional comparative data between the two timeframes is returned as well.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/poi/{poi_id}/overall/compare
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/overall/compare?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 | Overall Compare data has been successfully returned. |
Body
ComparedOverall
Field | Description | Type |
---|---|---|
actual | Overall data for the requested timeframe. | ComparableOverall |
comparison | Overall data for the self-calculated past timeframe. | ComparableOverall |
variation | Calculated difference between actual and comparison . |
OverallVariation |
ComparableOverall
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 |
Timeframe
Field | Description | Type |
---|---|---|
*from | Start date of timeframe. | date |
*to | End date of timeframe. | date |
OverallVariation
Field | Description | Type |
---|---|---|
sentiment | Sentiment variation. | Variation |
contents | Grouped by polarity variation of contents. | PolarizedVariation |
Variation
Field | Description | Type | Examples |
---|---|---|---|
value | Difference between actual value and comparison value. |
decimal | 1.12 |
variation | The explicit variation polarity. It is null when values are not available in both timeframes. |
string | POSITIVE NEUTRAL NEGATIVE |
Example
{
"actual": {
"value": {
"sentiment": {
"value": 76.90,
"polarity": "POSITIVE"
},
"contents": {
"positive": 472,
"negative": 118,
"neutral": 0,
"total": 590
}
},
"timeframe": {
"from": "2020-01-01",
"to": "2020-02-29"
}
},
"comparison": {
"value": {
"sentiment": {
"value": 79.84,
"polarity": "POSITIVE"
},
"contents": {
"positive": 471,
"negative": 95,
"neutral": 0,
"total": 566
}
},
"timeframe": {
"from": "2019-01-01",
"to": "2019-02-28"
}
},
"variation": {
"sentiment": {
"value": -2.94,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": 1,
"variation": "POSITIVE"
},
"negative": {
"value": 23,
"variation": "NEGATIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": 24,
"variation": "POSITIVE"
}
}
}
}