▪ Rating Series Grouped Compare
Rating Series Grouped Compare API returns two, time-based rating grouped data series along with a comparative calculation.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/locations/ratings/series/grouped/compare
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} | Actual location identifier. | Geospatial | AreaGeometryIDCircle | |
| *from | Start date of actual timeframe. | date | 2021-01-01 | |
| *to | End date of actual timeframe. | date | 2021-07-01 | |
| *period | Time unit of the series. | string | weekmonth | |
| *group_type | Field for which perform grouping. | string | poi_industrypoi_categorypoi_class | |
| {ComparisonLocation} | Comparison location identifier. | Comparison |
ComparisonAreaComparisonGeometryIDComparisonCircle | Same as {Location}. |
| compare_from | Start date of comparison timeframe. | date | 2020-07-01 | One year before from. |
| compare_to | End date of comparison timeframe. | date | 2021-01-01 | One year before to. |
| ⓝ networkⓝ compare_network | Filter by network. | string | Dictionary | |
| ⓝ poi_classⓝ compare_poi_class | Filter POIs with "category": "hotel" by stars rating in the range [1,5]. |
int | 4 | |
| ⓝ poi_industryⓝ compare_poi_industry | Filter by POI Industry. | string | Dictionary | |
| ⓝ poi_categoryⓝ compare_poi_category | Filter by POI Category. | string | Dictionary | |
| ⓝ user_typeⓝ compare_user_type | Filter by reviewer type. | string | Dictionary | |
| ⓝ user_countryⓝ compare_user_country | Filter by reviewer's country of origin in ISO 3166-1 alpha-2 standard format (in lower case). | string | itde | |
| ⓝ content_languageⓝ compare_content_language | Filter by contents language in ISO_639-1 standard format. | string | enfr | |
| ⓝ content_typeⓝ compare_content_type | Filter by type of content. | string | postreviewtaggedpost | review && taggedpost |
| 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 period
- week
- month
Supported values for group_type
- network
- poi_industry
- poi_category
- poi_class
- user_country
- content_language
- user_type
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/ratings/series/grouped/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&period=month&group_type=network&page_size=2' \
-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/grouped/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&period=month&group_type=network&page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Response
Status
| Status | Description |
|---|---|
| 200 | Rating Series Grouped Compare data has been successfully returned. |
Body
LocationGroupedComparedSeriesRatings
| Field | Description | Type |
|---|---|---|
| *results | Paginated grouped compared rating data series. | LocationGroupedComparedSeriesRatingsResults |
| paging | Response pagination. | Paging |
LocationGroupedComparedSeriesRatingsResults
| Field | Description | Type |
|---|---|---|
| actual | Ratings data series for the actual timeframe. | LocationGroupedComparableSeriesRatings |
| comparison | Ratings data series for the comparison timeframe. | LocationGroupedComparableSeriesRatings |
| variation | Calculated difference between actual and comparison. |
array[LocationSeriesGroupedRatingsVariation] |
LocationGroupedComparableSeriesRatings
| Field | Description | Type |
|---|---|---|
| timeframe | Reference date range. | Timeframe |
| value | Rating grouped data series for the corresponding timeframe. |
array[LocationGroupedSeriesRatingsElement] |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
LocationGroupedSeriesRatingsElement
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| *series | Rating data series of corresponding group. |
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 |
LocationSeriesGroupedRatingsVariation
| Field | Description | Type |
|---|---|---|
| *type | Field value within the requested grouping by field. | string |
| *series | Rating data variation series for the requested timeframe and period. | array[LocationSeriesRatingsVariationElement] |
LocationSeriesRatingsVariationElement
| Field | Description | Type |
|---|---|---|
| *actual_period | Date representing the actual period, corresponding to the first day of the period.week: first day of the corresponding week.month: first day of the corresponding month. |
date |
| *comparison_period | Date representing the comparison 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 | Rating variation data between actual_period and comparison_period. |
LocationRatingsVariation |
LocationRatingsVariation
| Field | Description | Type |
|---|---|---|
| contents | Contents variation. | Variation |
| rating | Rating variation. | Variation |
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": {
"timeframe": {
"from": "2021-01-01",
"to": "2021-02-28"
},
"value": [
{
"group": "tripadvisor",
"series": [
{
"period": "2021-01-01",
"value": {
"contents": {
"total": 12765
},
"rating": {
"average": 8.94,
"cap": 10
}
}
},
{
"period": "2021-02-01",
"value": {
"contents": {
"total": 12595
},
"rating": {
"average": 8.91,
"cap": 10
}
}
}
]
},
{
"group": "booking",
"series": [
{
"period": "2021-01-01",
"value": {
"contents": {
"total": 1288
},
"rating": {
"average": 8.51,
"cap": 10
}
}
},
{
"period": "2021-02-01",
"value": {
"contents": {
"total": 1981
},
"rating": {
"average": 8.51,
"cap": 10
}
}
}
]
}
]
},
"comparison": {
"timeframe": {
"from": "2020-11-01",
"to": "2020-12-31"
},
"value": [
{
"group": "tripadvisor",
"series": [
{
"period": "2020-11-01",
"value": {
"contents": {
"total": 11453
},
"rating": {
"average": 8.87,
"cap": 10
}
}
},
{
"period": "2020-12-01",
"value": {
"contents": {
"total": 9098
},
"rating": {
"average": 8.88,
"cap": 10
}
}
}
]
},
{
"group": "booking",
"series": [
{
"period": "2020-11-01",
"value": {
"contents": {
"total": 3125
},
"rating": {
"average": 8.51,
"cap": 10
}
}
},
{
"period": "2020-12-01",
"value": {
"contents": {
"total": 1150
},
"rating": {
"average": 8.5,
"cap": 10
}
}
}
]
}
]
},
"variation": [
{
"type": "tripadvisor",
"series": [
{
"actual_period": "2021-01-01",
"comparison_period": "2020-11-01",
"value": {
"contents": {
"value": 1312,
"variation": "POSITIVE"
},
"rating": {
"value": 0.07,
"variation": "POSITIVE"
}
}
},
{
"actual_period": "2021-02-01",
"comparison_period": "2020-12-01",
"value": {
"contents": {
"value": 3497,
"variation": "POSITIVE"
},
"rating": {
"value": 0.03,
"variation": "POSITIVE"
}
}
}
]
},
{
"type": "booking",
"series": [
{
"actual_period": "2021-01-01",
"comparison_period": "2020-11-01",
"value": {
"contents": {
"value": -1837,
"variation": "NEGATIVE"
},
"rating": {
"value": 0.0,
"variation": "NEUTRAL"
}
}
},
{
"actual_period": "2021-02-01",
"comparison_period": "2020-12-01",
"value": {
"contents": {
"value": 831,
"variation": "POSITIVE"
},
"rating": {
"value": 0.01,
"variation": "POSITIVE"
}
}
}
]
}
]
},
"paging": {
"last": "/ratings/series/grouped/compare?page=9&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"first": "/ratings/series/grouped/compare?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"prev": null,
"next": "/ratings/series/grouped/compare?page=2&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"current": "/ratings/series/grouped/compare?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"pages": [
{
"number": 1,
"uri": "/ratings/series/grouped/compare?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 2,
"uri": "/ratings/series/grouped/compare?page=2&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 3,
"uri": "/ratings/series/grouped/compare?page=3&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 4,
"uri": "/ratings/series/grouped/compare?page=4&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 5,
"uri": "/ratings/series/grouped/compare?page=5&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
}
],
"elements": [
1,
2
],
"total": 17,
"size": 2
}
}