APIAnalytics

Сводная аналитика группы

GET
/v2/analytics

Сводная аналитика по отзывам группы за период (канонические имена /v2).

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Query Parameters

group_id*Group Id

Идентификатор группы. Обязательный параметр.

source_ids?array<integer>

Фильтр по площадкам (id из GET /v2/sources). Пусто — все площадки группы.

Default[]
published_from?|

Начало периода по дате публикации, включительно (YYYY-MM-DD). По умолчанию 2020-01-01.

published_to?|

Конец периода по дате публикации, включительно (YYYY-MM-DD). По умолчанию сегодня.

min_rating?Min Rating

Нижняя граница оценки (1–5, дробное), включительно. По умолчанию 1.

Range1 <= value <= 5
Default1
max_rating?Max Rating

Верхняя граница оценки (1–5, дробное), включительно. По умолчанию 5.

Range1 <= value <= 5
Default5

Response Body

application/json

application/json

curl -X GET "https://example.com/v2/analytics?group_id=0"
{  "meta": {    "group_id": 0,    "published_from": "2019-08-24",    "published_to": "2019-08-24",    "source_ids": [      0    ],    "generated_at": "2019-08-24T14:15:22Z"  },  "summary": {    "total_reviews": 0,    "avg_rating": 0,    "reviews_with_text": 0,    "reviews_with_images": 0,    "rating_distribution": {      "property1": 0,      "property2": 0    },    "reply": {      "total_with_reply": 0,      "unanswered_negative": 0,      "reply_by_rating": {        "property1": 0,        "property2": 0      },      "last_reply_date": "2019-08-24"    }  },  "by_source": [    {      "source_id": 0,      "source_name": "string",      "review_count": 0,      "avg_rating": 0,      "total_with_reply": 0,      "reviews_with_text": 0,      "reviews_with_images": 0,      "rating_distribution": {        "property1": 0,        "property2": 0      },      "reply_distribution": {        "property1": 0,        "property2": 0      },      "latest_review_date": "2019-08-24"    }  ]}