Skip to content

▪ Overall Grouped Compare

Pricing Tier Licence Type

Overall Grouped Compare API returns two, time-based overall grouped data sets along with a comparative calculation.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/poi/{poi_id}/overall/grouped/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
*group_type Field for which perform grouping. string network
user_country
content_language
user_type
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
② order_by Order results by specifying:
      ±{order_value}
Results in ascending order:
      {order_value} or +{order_value}
Results in descending order:
      -{order_value}		 string +contents.total
-contents.positive
contents.negative
+contents.neutral
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 {order_by}
  • contents.total, +contents.total, -contents.total
  • contents.positive, +contents.positive, -contents.positive
  • contents.negative, +contents.negative, -contents.negative
  • contents.neutral, +contents.neutral, -contents.neutral
Example 
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/HF8xjSQW4W43NGr56denSh/overall/grouped/compare?from=2020-01-01&to=2020-02-29&group_type=network&page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Overall Grouped Compare data has been successfully returned.

Body

GroupedComparedOverall

Field Description Type
*results Paginated grouped compared overall data. GroupedComparedOverallResults
paging Response pagination. Paging
GroupedComparedOverallResults
Field Description Type
actual Overall grouped data for the requested timeframe. GroupedComparableOverall
comparison Overall grouped data for the self-calculated past timeframe. GroupedComparableOverall
variation Calculated difference between actual and comparison. array[GroupedOverallVariation]
GroupedComparableOverall
Field Description Type
value Overall grouped data for the corresponding timeframe. array[GroupedOverallElement]
timeframe Reference date range. Timeframe
GroupedOverallElement
Field Description Type
*group Field value within the requested grouping by field. string
*overall Overall data of corresponding group. 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
Timeframe
Field Description Type
*from Start date of timeframe. date
*to End date of timeframe. date
GroupedOverallVariation
Field Description Type
*group Field value within the requested grouping by field. string
*compare Overall variation data of corresponding group. OverallVariation
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
PolarizedVariation
Field Description Type
positive Positive elements count variation. Variation
negative Negative elements count variation. Variation
neutral Neutral elements count variation. Variation
total Total elements count variation. Variation
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": [
                {
                    "group": "agoda",
                    "overall": {
                        "sentiment": {
                            "value": 67.00,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 1,
                            "negative": 1,
                            "neutral": 0,
                            "total": 2
                        }
                    }
                },
                {
                    "group": "booking",
                    "overall": {
                        "sentiment": {
                            "value": 79.29,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 315,
                            "negative": 66,
                            "neutral": 0,
                            "total": 381
                        }
                    }
                }
            ],
            "timeframe": {
                "from": "2020-01-01",
                "to": "2020-02-29"
            }
        },
        "comparison": {
            "value": [
                {
                    "group": "booking",
                    "overall": {
                        "sentiment": {
                            "value": 81.62,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 354,
                            "negative": 61,
                            "neutral": 0,
                            "total": 415
                        }
                    }
                }
            ],
            "timeframe": {
                "from": "2019-01-01",
                "to": "2019-02-28"
            }
        },
        "variation": [
            {
                "group": "agoda",
                "compare": {
                    "sentiment": {
                        "value": null,
                        "variation": null
                    },
                    "contents": {
                        "positive": {
                            "value": 1,
                            "variation": "POSITIVE"
                        },
                        "negative": {
                            "value": 1,
                            "variation": "NEGATIVE"
                        },
                        "neutral": {
                            "value": 0,
                            "variation": "NEUTRAL"
                        },
                        "total": {
                            "value": 2,
                            "variation": "POSITIVE"
                        }
                    }
                }
            },
            {
                "group": "booking",
                "compare": {
                    "sentiment": {
                        "value": -2.33,
                        "variation": "NEGATIVE"
                    },
                    "contents": {
                        "positive": {
                            "value": -39,
                            "variation": "NEGATIVE"
                        },
                        "negative": {
                            "value": 5,
                            "variation": "NEGATIVE"
                        },
                        "neutral": {
                            "value": 0,
                            "variation": "NEUTRAL"
                        },
                        "total": {
                            "value": -34,
                            "variation": "NEGATIVE"
                        }
                    }
                }
            }
        ]
    },
    "paging": {
        "last": "/overall/grouped/compare?page=3&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29",
        "first": "/overall/grouped/compare?page=1&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29",
        "prev": null,
        "next": "/overall/grouped/compare?page=2&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29",
        "current": "/overall/grouped/compare?page=1&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29",
        "pages": [
            {
                "number": 1,
                "uri": "/overall/grouped/compare?page=1&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29"
            },
            {
                "number": 2,
                "uri": "/overall/grouped/compare?page=2&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29"
            },
            {
                "number": 3,
                "uri": "/overall/grouped/compare?page=3&page_size=2&from=2020-01-01&group_type=network&to=2020-02-29"
            }
        ],
        "elements": [
            1,
            2
        ],
        "total": 6,
        "size": 2
    }
}