APIAnalytics

Динамика отзывов по периодам

GET
/v2/analytics/timeseries

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

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Query Parameters

group_id*Group Id

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

source_ids?array<integer>

Площадки для разбивки; 0 — агрегированный ряд. По умолчанию [0].

Default[]
granularity?Granularity

Размер интервала: day / week / month.

Default"month"

Value in

  • "day"
  • "week"
  • "month"
published_from?|

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

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/timeseries?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",    "granularity": "string"  },  "series": [    {      "source_id": 0,      "source_name": "string",      "timeseries": [        {          "period": "string",          "review_count": 0,          "avg_rating": 0,          "reviews_with_text": 0,          "reviews_with_images": 0,          "reply_count": 0,          "rating_distribution": {            "property1": 0,            "property2": 0          },          "reply_distribution": {            "property1": 0,            "property2": 0          }        }      ]    }  ]}