▪ Clusters Compare
Clusters Compare API returns clusters data of 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}/clusters/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 | Default |
|---|---|---|---|---|
| *from | Start date of timeframe. | date | 2020-01-01 | |
| *to | End date of timeframe. | date | 2020-12-31 | |
| topic | Filter by topic. | string | 2 starsdinner | |
| cluster | Filter by cluster. | string | Dictionary | |
| language | Translate cluster names in the specified language.It also allows the user to filter by cluster and topic parameter by setting its value in the specified language. |
string | itfr | en |
| reply_received | Filter by contents with a reply. | boolean | truefalse | |
| ⓝ 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 | itde | |
| ⓝ content_language | Filter by contents language in ISO_639-1 standard format. | string | enfr | |
| ⓝ user_type | Filter by user type. | string | Dictionary | |
| page | Requested page number for paginated results. | int | 1 | |
| page_size | Requested page size for paginated results in the range [1, 100]. | int | 25 |
Supported values for language
- en
- it
- fr
- es
- de
Example
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/HF8xjSQW4W43NGr56denSh/clusters/overall/compare?from=2020-01-01&to=2020-02-29&page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Response
Status
| Status | Description |
|---|---|
| 200 | Clusters Compare data has been successfully returned. |
Body
ComparedClusters
| Field | Description | Type |
|---|---|---|
| *results | Paginated compared clusters data. | ComparedClustersResults |
| paging | Response pagination. | Paging |
ComparedClustersResults
| Field | Description | Type |
|---|---|---|
| actual | Clusters grouped data for the requested timeframe. | ComparableClusters |
| comparison | Clusters grouped data for the self-calculated past timeframe. | ComparableClusters |
| variation | Calculated difference between actual and comparison. |
array[ClusterVariationElement] |
ComparableClusters
| Field | Description | Type |
|---|---|---|
| value | Clusters data for the corresponding timeframe. |
array[Cluster] |
| timeframe | Reference date range. | Timeframe |
Cluster
| Field | Description | Type |
|---|---|---|
| :fontawesome-solid-exclamation-circle: |
||
| contents | Total and grouped by polarity count of contents. | PolarizedCount |
| opinions | Total and grouped by polarity count of opinions. | PolarizedCount |
| sentiment | KPI which indicates users global satisfaction. | PolarizedValue |
| :fontawesome-solid-sync-alt: cluster | Descriptive identifier of the cluster. | string |
PolarizedCount
| Field | Description | Type |
|---|---|---|
| positive | Positive elements count. | int |
| negative | Negative elements count. | int |
| neutral | Neutral elements count. | int |
| total | Total elements count. | int |
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 |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
ClusterVariationElement
| Field | Description | Type |
|---|---|---|
| *name | Descriptive identifier of the cluster. | string |
| *compare | Cluster variation data. | FullVariation |
FullVariation
| Field | Description | Type |
|---|---|---|
| sentiment | Sentiment variation. | Variation |
| contents | Grouped by polarity contents variation. | PolarizedVariation |
| opinions | Grouped by polarity opinions variation. | 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 |
Paging
| Field | Description | Type |
|---|---|---|
| last | A relative URI to the last page. | string |
| first | A relative URI to the first page. | string |
| prev | A relative URI to the previous page. | string |
| next | A relative URI to the next page. | string |
| current | A relative URI to the current page. | string |
| pages | A set of relative URIs calculated around the current page. | Page |
| elements | All indexes shown on the current page. | array[int] |
| total | The number of all elements that API can retrieve. | int |
| size | The selected page size. | int |
Page
| Field | Description | Type |
|---|---|---|
| number | Number of the page. | int |
| uri | URI of the page. | string |
Example
{
"results": {
"actual": {
"value": [
{
"name": "atmosphere",
"contents": {
"positive": 335,
"negative": 57,
"neutral": 0,
"total": 392
},
"opinions": {
"positive": 439,
"negative": 117,
"neutral": 0,
"total": 556
},
"sentiment": {
"value": 78.96,
"polarity": "POSITIVE"
}
},
{
"name": "room",
"contents": {
"positive": 60,
"negative": 59,
"neutral": 0,
"total": 119
},
"opinions": {
"positive": 112,
"negative": 154,
"neutral": 0,
"total": 266
},
"sentiment": {
"value": 42.11,
"polarity": "NEGATIVE"
}
}
],
"timeframe": {
"from": "2020-01-01",
"to": "2020-02-29"
}
},
"comparison": {
"value": [
{
"name": "atmosphere",
"contents": {
"positive": 338,
"negative": 51,
"neutral": 0,
"total": 389
},
"opinions": {
"positive": 475,
"negative": 118,
"neutral": 0,
"total": 593
},
"sentiment": {
"value": 80.10,
"polarity": "POSITIVE"
}
},
{
"name": "room",
"contents": {
"positive": 92,
"negative": 32,
"neutral": 0,
"total": 124
},
"opinions": {
"positive": 139,
"negative": 132,
"neutral": 0,
"total": 271
},
"sentiment": {
"value": 51.29,
"polarity": "NEGATIVE"
}
}
],
"timeframe": {
"from": "2019-01-01",
"to": "2019-02-28"
}
},
"variation": [
{
"name": "atmosphere",
"compare": {
"sentiment": {
"value": -1.14,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": -3,
"variation": "NEGATIVE"
},
"negative": {
"value": 6,
"variation": "NEGATIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": 3,
"variation": "POSITIVE"
}
},
"opinions": {
"positive": {
"value": -36,
"variation": "NEGATIVE"
},
"negative": {
"value": -1,
"variation": "POSITIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": -37,
"variation": "NEGATIVE"
}
}
}
},
{
"name": "room",
"compare": {
"sentiment": {
"value": -9.18,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": -32,
"variation": "NEGATIVE"
},
"negative": {
"value": 27,
"variation": "NEGATIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": -5,
"variation": "NEGATIVE"
}
},
"opinions": {
"positive": {
"value": -27,
"variation": "NEGATIVE"
},
"negative": {
"value": 22,
"variation": "NEGATIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": -5,
"variation": "NEGATIVE"
}
}
}
}
]
},
"paging": {
"last": "/clusters/overall/compare?page=8&page_size=2&from=2020-01-01&to=2020-02-29",
"first": "/clusters/overall/compare?page=1&page_size=2&from=2020-01-01&to=2020-02-29",
"prev": null,
"next": "/clusters/overall/compare?page=2&page_size=2&from=2020-01-01&to=2020-02-29",
"current": "/clusters/overall/compare?page=1&page_size=2&from=2020-01-01&to=2020-02-29",
"pages": [
{
"number": 1,
"uri": "/clusters/overall/compare?page=1&page_size=2&from=2020-01-01&to=2020-02-29"
},
{
"number": 2,
"uri": "/clusters/overall/compare?page=2&page_size=2&from=2020-01-01&to=2020-02-29"
},
{
"number": 3,
"uri": "/clusters/overall/compare?page=3&page_size=2&from=2020-01-01&to=2020-02-29"
},
{
"number": 4,
"uri": "/clusters/overall/compare?page=4&page_size=2&from=2020-01-01&to=2020-02-29"
},
{
"number": 5,
"uri": "/clusters/overall/compare?page=5&page_size=2&from=2020-01-01&to=2020-02-29"
}
],
"elements": [
1,
2
],
"total": 16,
"size": 2
}
}