Получение данных по времени

Позволяет получить данные с разбивкой по времени (например, по дням, неделям, месяцам). Используйте данный тип запроса для построения графиков и отслеживания динамики.

Request

GET

https://api.appmetrica.yandex.net/stat/v1/data/bytime

Query parameters

Name

Description

params

Type: BytimeParams

Example: ``

statGroupParams

Type: StatGroupParams

Example: ``

BytimeParams

Name	Description
access_filter_id	Type: integer
accuracy	Type: string Example: `example`
annotation_groups	Type: string[] Example `[ "example" ]`
callback	Type: string Example: `example`
confidence_level	Type: string Default: `0.95`
date_dimension	Type: string Example: `example`
date1	Type: string Default: `6daysAgo`
date2	Type: string Default: `today`
dimensions	Type: string Example: `example`
direct_client_ids	Type: integer[] Example `[ 0 ]`
direct_client_logins	Type: string[] Example `[ "example" ]`
exclude_insignificant	Type: boolean
filters	Type: string Example: `example`
group	Type: string Группировка данных по времени: `all` — временной интервал не разбивается; `auto` — интервал устанавливается с учетом выбранного отчетного периода и количества данных, достаточного для этого периода; `minutes` — временной интервал разбивается на интервалы из некоторого количества минут. Возможные интервалы minutes: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120, 180, 240, 360, 480, 720, 1440. Расчеты оптимизированы так, чтобы между точками на графике не было больше одного интервала, с лимитом в 1600 точек для минут; `dekaminute` — временной интервал разбивается на 10-минутные интервалы; `minute` — временной интервал разбивается на минутные интервалы; `hour` — временной интервал разбивается на часовые интервалы; `hours` — временной интервал разбивается на интервалы из нескольких часов. Возможные интервалы hours: 1, 2, 3, 4, 6, 8, 12, 24. Расчеты оптимизированы так, чтобы между точками на графике не было больше одного интервала, с лимитом в 30 точек для часов; `day` — временной интервал разбивается по дням; `week` — временной интервал разбивается по неделям; `month` — временной интервал разбивается по месяцам; `quarter` — временной интервал разбивается по кварталам; `year` — временной интервал разбивается по годам. Default: `week`
ids	Type: integer[] Example `[ 0 ]`
include_annotations	Type: string Default: `false`
include_meta	Type: boolean
include_undefined	Type: boolean
keys_sort	Type: string Example: `example`
lang	Type: string Example: `example`
max_deviation	Type: string Default: `0.1`
metrics	Type: string Example: `example`
preset	Type: string Example: `example`
pretty	Type: string Default: `false`
proposed_accuracy	Type: boolean
reference_row_id	Type: string[] Example `[ "example" ]`
request_domain	Type: string Example: `example`
require_metric_values	Type: string Default: `false`
row_ids	Type: string[][] Example `[ [ "example" ] ]`
timezone	Type: string Example: `example`
top_keys	Type: string Default: `7`
with_confidence	Type: boolean

Example

{
  "ids": [
    0
  ],
  "direct_client_ids": [
    0
  ],
  "direct_client_logins": [
    "example"
  ],
  "date1": "6daysAgo",
  "date2": "today",
  "timezone": "example",
  "preset": "example",
  "metrics": "example",
  "dimensions": "example",
  "reference_row_id": [
    "example"
  ],
  "filters": "example",
  "accuracy": "example",
  "proposed_accuracy": true,
  "include_undefined": true,
  "include_meta": true,
  "with_confidence": true,
  "exclude_insignificant": true,
  "confidence_level": "0.95",
  "max_deviation": "0.1",
  "pretty": "false",
  "lang": "example",
  "request_domain": "example",
  "require_metric_values": "false",
  "access_filter_id": 0,
  "group": "week",
  "callback": "example",
  "date_dimension": "example",
  "row_ids": [
    [
      "example"
    ]
  ],
  "top_keys": "7",
  "keys_sort": "example",
  "include_annotations": "false",
  "annotation_groups": [
    "example"
  ]
}

StatGroupParams

Name

Description

label_id

Type: integer

Min value: 1

org_id

Type: integer

Min value: 1

Example

{
  "org_id": 1,
  "label_id": 1
}

Responses

200 OK

Body

application/json

{
  "query": {
    "timezone": "example",
    "preset": "example",
    "dimensions": [
      "example"
    ],
    "metrics": [
      "example"
    ],
    "sort": [
      "example"
    ],
    "date1": "example",
    "date2": "example",
    "filters": "example"
  },
  "data": [
    {
      "dimensions": [
        {}
      ],
      "metrics": [
        [
          0.5
        ]
      ]
    }
  ],
  "total_rows": 0,
  "total_rows_rounded": true,
  "sampled": true,
  "contains_sensitive_data": true,
  "sample_share": 0.5,
  "sample_size": 0,
  "sample_space": 0,
  "data_lag": 0,
  "totals": [
    [
      0.5
    ]
  ],
  "annotations": [
    [
      {
        "id": 0,
        "date": "2025-01-01",
        "time": "12:00:00",
        "title": "example",
        "message": "example",
        "group": "example"
      }
    ]
  ]
}

Name	Description
annotations	Type: ConstructorReportChartAnnotation[][] Примечания. Example `[ [ { "id": 0, "date": "2025-01-01", "time": "12:00:00", "title": "example", "message": "example", "group": "example" } ] ]`
contains_sensitive_data	Type: boolean Признак возможного отсутствия конфиденциальных данных в ответе. К ним относятся данные, которые рассчитываются алгоритмами Яндекса, например, социально-демографические (пол, возраст и др.), адреса страниц входа, поисковые фразы, информация о роботах. При значении `true` в ответе не отобразятся такие данные, если выборка составляет меньше 10 посетителей. Возможные значения: `true`, `false`.
data	Type: DynamicRow[] Example `[ { "dimensions": [ {} ], "metrics": [ [ 0.5 ] ] } ]`
data_lag	Type: integer Задержка в обновлении данных, в секундах.
query	Type: DynamicQueryExternal Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов. Example `{ "timezone": "example", "preset": "example", "dimensions": [ "example" ], "metrics": [ "example" ], "sort": [ "example" ], "date1": "example", "date2": "example", "filters": "example" }`
sample_share	Type: number Доля данных, по которым осуществлялся расчет. Доступно значение в пределах от 0 до 1.
sample_size	Type: integer Количество строк в выборке данных.
sample_space	Type: integer Количество строк данных.
sampled	Type: boolean Признак семплирования. Показывает, был ли применен семплинг. Возможные значения: `true`, `false`.
total_rows	Type: integer Общее количество строк в ответе по всему множеству данных (с учетом фильтра).
total_rows_rounded	Type: boolean Признак того, что общее количество строк было округлено.
totals	Type: number[][] Общие результаты для метрик по всему множеству данных (с учетом фильтра). Example `[ [ 0.5 ] ]`

DynamicQueryExternal

Исходный запрос. Содержит параметры запроса, включая развернутые параметры из шаблона и параметры для схемы параметризации атрибутов.

Name	Description
date1	Type: string Дата начала периода выборки в формате YYYY-MM-DD. Example: `example`
date2	Type: string Дата окончания периода выборки в формате YYYY-MM-DD. Example: `example`
dimensions	Type: string[] Example `[ "example" ]`
filters	Type: string Фильтр сегментации. Example: `example`
metrics	Type: string[] Example `[ "example" ]`
preset	Type: string Пресет отчета. Example: `example`
sort	Type: string[] Example `[ "example" ]`
timezone	Type: string Часовой пояс периода выборки в формате ±hh:mm. Example: `example`

Example

{
  "timezone": "example",
  "preset": "example",
  "dimensions": [
    "example"
  ],
  "metrics": [
    "example"
  ],
  "sort": [
    "example"
  ],
  "date1": "example",
  "date2": "example",
  "filters": "example"
}

DynamicRow

Строки ответа. Представляет собой массив, каждый элемент которого — одна строка результата.

Name

Description

dimensions

Type: object[]

[additional]

Type: string

Example: example

Массив значений группировок для данной строки. Каждое из значений группировки представляет собой объект. В нем обязательно присутствует поле name — текстовое значение, но могут присутствовать дополнительные поля, например идентификатор — id.

Example

[
  {}
]

metrics

Type: number[][]

Массив массивов значений метрик для данной строки. Внешний массив перечисляет метрики, внутренние массивы — значения конкретной метрики для каждой временной группы.

Example

[
  [
    0.5
  ]
]

Example

{
  "dimensions": [
    {}
  ],
  "metrics": [
    [
      0.5
    ]
  ]
}

ConstructorReportChartAnnotation

Name	Description
date	Type: string<date> Дата. Example: `2025-01-01`
group	Type: string Группа: `A` — группа A. `B` — группа B. `C` — группа C. `D` — группа D. `E` — группа E. `HOLIDAY` — государственные праздники. Отображаются, если Яндекс Метрике удалось определить регион счетчика. Example: `example`
id	Type: integer Идентификатор примечания.
message	Type: string Описание. Example: `example`
time	Type: string<time> Время. Example: `12:00:00`
title	Type: string Заголовок. Example: `example`

Example

{
  "id": 0,
  "date": "2025-01-01",
  "time": "12:00:00",
  "title": "example",
  "message": "example",
  "group": "example"
}

Была ли статья полезна?

Drill down

Все измерения