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

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

Request

GET

https://api-metrika.yandex.net/stat/v1/data/bytime

Query parameters

Name

Description

ids

Type: integer[]

Идентификаторы счетчиков, через запятую.

Example: 44147844,2215573

metrics

Type: string

Список метрик, разделенных запятой. Лимит: 20 метрик в запросе.

Example: ym:s:pageviews

accuracy

Type: string

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

Example: ``

annotation_groups

Type: string[]

Группы примечаний, разделенные запятой, которые должны вернуться в ответе. Передается, если параметр include_annotations принимает значение true Если параметр annotation_groups не указан, в ответе вернутся все примечания, созданные для счетчика.

Example: ``

callback

Type: string

Функция обратного вызова, которая обрабатывает ответ API.

Example: ``

date1

Type: string

Дата начала периода выборки в формате YYYY-MM-DD. Также используйте значения: today, yesterday, ndaysAgo.

Default: 6daysAgo

Example: ``

date2

Type: string

Дата окончания периода выборки в формате YYYY-MM-DD. Также используйте значения: today, yesterday, ndaysAgo.

Default: today

Example: ``

dimensions

Type: string

Список группировок, разделенных запятой. Лимит: 10 группировок в запросе.

Example: ym:s:trafficSource

direct_client_logins

Type: string[]

Логины клиентов Яндекс Директа, через запятую. Могут использоваться для формирования отчета Директ-расходы.

Example: login1,login2

filters

Type: string

Фильтр сегментации. Лимит: количество уникальных группировок и метрик — до 10, количество отдельных фильтров — до 20, длина строки в фильтре — до 10 000 символов; количество значений в одном условии фильтрации — 100.

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

Example: ``

include_annotations

Type: string

Признак включения в ответ примечания. По умолчанию выключено.

Default: false

Example: ``

include_undefined

Type: boolean

Включает в ответ строки, для которых значения группировок не определены. Влияет только на первую группировку. По умолчанию выключено.

keys_sort

Type: string

Список группировок и метрик, разделенных запятой, по которым осуществляется сортировка. По умолчанию сортировка производится по убыванию (указан знак - перед группировкой или метрикой). Чтобы отсортировать данные по возрастанию, удалите знак -.

Example: ``

lang

Type: string

Язык.

Example: ``

preset

Type: string

Шаблон отчета.

Example: sources_summary

pretty

Type: string

Задает форматирование результата. Чтобы использовать форматирование, укажите значение true.

Default: false

Example: ``

proposed_accuracy

Type: boolean

Если параметр выставлен в true, API имеет право автоматически увеличивать accuracy до рекомендованного значения.Когда идет запрос в маленькую таблицу с очень маленьким семплингом, параметр поможет получить осмысленные результаты.

row_ids

Type: string[][]

Выбор строк для построения графиков. Содержит перечисление списков ключей.

Example: ``

timezone

Type: string

Часовой пояс в формате ±hh:mm в диапазоне [-23:59; +23:59] (знак плюса нужно передавать как %2B), в котором будут рассчитан период выборки запроса, а также связанные с датой и временем группировки. По умолчанию используется часовой пояс счетчика.

Example: +03:00

top_keys

Type: string

Задает количество строк результата, если не указан параметр row_ids. Максимальное количество строк: 30.

Default: 7

Example: ``

Responses

200 OK

OK

Body

application/json
{
  "query": {
    "ids": [
      0
    ],
    "timezone": "example",
    "preset": "example",
    "dimensions": [
      "example"
    ],
    "metrics": [
      "example"
    ],
    "sort": [
      "example"
    ],
    "date1": "example",
    "date2": "example",
    "filters": "example"
  },
  "data": [
    {
      "dimensions": [
        {}
      ],
      "metrics": [
        [
          0.5
        ]
      ]
    }
  ],
  "meta": {
    "dimensions": [
      {
        "id": "example",
        "dim": "example",
        "name": "example",
        "short_name": "example",
        "group_name": "example",
        "description": "example",
        "type": "example",
        "disallow_by_time": true,
        "allow_filters": true,
        "parameter": {
          "id": "example",
          "description": "example",
          "dim": "example"
        },
        "fields": {},
        "allow_sort": true,
        "default_sort": "example",
        "allow_null": true,
        "sub_table": "example",
        "permission_scope": "example",
        "since": "example",
        "advanced": true,
        "required_keys": [
          "example"
        ],
        "features": [
          "example"
        ],
        "chained_attributes_group_name": "example",
        "chained_attributes_group_index": 0,
        "secret": true,
        "exposes_secret_data": true,
        "disjoint": true,
        "relations": [
          "example"
        ]
      }
    ],
    "metrics": [
      {
        "dim": "example",
        "metric_string": "example",
        "name": "example",
        "description": "example",
        "allow_normalisation": true,
        "require_dynamic_correction": true,
        "allow_filters": true,
        "type": "example",
        "allow_sort": true,
        "default_sort": "example",
        "advanced": true,
        "support_confidence": true,
        "negative": true,
        "parameters": [
          null
        ],
        "sub_table": "example",
        "required_dimension": "example",
        "permission_scope": "example",
        "since": "example",
        "required_keys": [
          "example"
        ],
        "features": [
          "example"
        ],
        "secret": true,
        "exposes_secret_data": true
      }
    ]
  },
  "total_rows": 0,
  "total_rows_rounded": true,
  "with_confidence": true,
  "exclude_insignificant": true,
  "sampled": true,
  "sampleable": true,
  "contains_sensitive_data": true,
  "sample_share": 0.5,
  "max_sample_share": 0.5,
  "min_sample_share": 0.5,
  "sample_size": 0,
  "sample_space": 0,
  "data_lag": 0,
  "totals": [
    [
      0.5
    ]
  ],
  "last_period_index": 0,
  "time_intervals": [
    [
      "example"
    ]
  ],
  "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

Задержка в обновлении данных, в секундах.

meta

Type: Meta

Метаданные запроса. Содержит описание группировок и метрик запроса.

Example
{
  "dimensions": [
    {
      "id": "example",
      "dim": "example",
      "name": "example",
      "short_name": "example",
      "group_name": "example",
      "description": "example",
      "type": "example",
      "disallow_by_time": true,
      "allow_filters": true,
      "parameter": {
        "id": "example",
        "description": "example",
        "dim": "example"
      },
      "fields": {},
      "allow_sort": true,
      "default_sort": "example",
      "allow_null": true,
      "sub_table": "example",
      "permission_scope": "example",
      "since": "example",
      "advanced": true,
      "required_keys": [
        "example"
      ],
      "features": [
        "example"
      ],
      "chained_attributes_group_name": "example",
      "chained_attributes_group_index": 0,
      "secret": true,
      "exposes_secret_data": true,
      "disjoint": true,
      "relations": [
        "example"
      ]
    }
  ],
  "metrics": [
    {
      "dim": "example",
      "metric_string": "example",
      "name": "example",
      "description": "example",
      "allow_normalisation": true,
      "require_dynamic_correction": true,
      "allow_filters": true,
      "type": "example",
      "allow_sort": true,
      "default_sort": "example",
      "advanced": true,
      "support_confidence": true,
      "negative": true,
      "parameters": [
        null
      ],
      "sub_table": "example",
      "required_dimension": "example",
      "permission_scope": "example",
      "since": "example",
      "required_keys": [
        "example"
      ],
      "features": [
        "example"
      ],
      "secret": true,
      "exposes_secret_data": true
    }
  ]
}

query

Type: DynamicQueryExternal

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

Example
{
  "ids": [
    0
  ],
  "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
    ]
  ]
}

ParamMetaExternal

Список параметров метрики

Name

Description

description

Type: string

Описание параметра

Example: example

dim

Type: string

Имя измерения с значениями

Example: example

id

Type: string

Идентификатор параметра

Example: example
Example
{
  "id": "example",
  "description": "example",
  "dim": "example"
}

DimensionMetaExternal

Name

Description

advanced

Type: boolean

Группировка для опытного пользователя

allow_filters

Type: boolean

Возможно ли использование фильтров

allow_null

Type: boolean

Разрешается ли показывать для этой группировки "Не определено"

allow_sort

Type: boolean

Возможно ли сортировать по этой группировке

chained_attributes_group_index

Type: integer

Порядок группировки в группе связанных группировок

chained_attributes_group_name

Type: string

Имя группы связанных группировок

Example: example

default_sort

Type: string

Способ сортировки:

  • asc
  • desc

Example: example

description

Type: string

Описание метрики

Example: example

dim

Type: string

Группировка

Example: example

disallow_by_time

Type: boolean

Запрещено ли для этой группировки сочетание с группировкой по времени.

features

Type: string[]

Характеристики счетчика, необходимые для использования группировки

Unique items: true

Example
[
  "example"
]

fields
Type: object

[additional]

Type: DimensionMetaExternal

Example
{
  "id": "example",
  "dim": "example",
  "name": "example",
  "short_name": "example",
  "group_name": "example",
  "description": "example",
  "type": "example",
  "disallow_by_time": true,
  "allow_filters": true,
  "parameter": {
    "id": "example",
    "description": "example",
    "dim": "example"
  },
  "fields": {},
  "allow_sort": true,
  "default_sort": "example",
  "allow_null": true,
  "sub_table": "example",
  "permission_scope": "example",
  "since": "example",
  "advanced": true,
  "required_keys": [
    "example"
  ],
  "features": [
    "example"
  ],
  "chained_attributes_group_name": "example",
  "chained_attributes_group_index": 0,
  "secret": true,
  "exposes_secret_data": true,
  "disjoint": true,
  "relations": [
    "example"
  ]
}

Дополнительные поля для этой группировки

Example
{}

group_name

Type: string

Название группировки при перечислении

Example: example

id

Type: string

Идентификатор группировки без префикса и параметров

Example: example

name

Type: string

Название группировки

Example: example

parameter

Type: ParamMetaExternal

Список параметров метрики

Example
{
  "id": "example",
  "description": "example",
  "dim": "example"
}

permission_scope

Type: string

Группа доступа к группировке

Example: example

required_keys

Type: string[]

Example
[
  "example"
]

short_name

Type: string

Название группировки

Example: example

since

Type: string

Дата появления данных для группировки

Example: example

sub_table

Type: string

Подтаблица

Example: example

type

Type: string

Интерфейсный тип группировки

Example: example
Example
{
  "id": "example",
  "dim": "example",
  "name": "example",
  "short_name": "example",
  "group_name": "example",
  "description": "example",
  "type": "example",
  "disallow_by_time": true,
  "allow_filters": true,
  "parameter": {
    "id": "example",
    "description": "example",
    "dim": "example"
  },
  "fields": {},
  "allow_sort": true,
  "default_sort": "example",
  "allow_null": true,
  "sub_table": "example",
  "permission_scope": "example",
  "since": "example",
  "advanced": true,
  "required_keys": [
    "example"
  ],
  "features": [
    "example"
  ],
  "chained_attributes_group_name": "example",
  "chained_attributes_group_index": 0
}

MetricMetaExternal

Массив метаданных метрик запроса.

Name

Description

advanced

Type: boolean

Метрика для опытных пользователей

allow_filters

Type: boolean

Возможно ли использование фильтров

allow_normalisation

Type: boolean

Возможна ли нормализация значений

allow_sort

Type: boolean

Возможно ли сортировать по этой метрике

default_sort

Type: string

Способ сортировки:

  • asc
  • desc

Example: example

description

Type: string

Описание метрики

Example: example

dim

Type: string

Метрика

Example: example

exposes_secret_data

Type: boolean

Раскрывает секретные данные

features

Type: string[]

Характеристики счетчика, необходимые для использования метрики

Unique items: true

Example
[
  "example"
]

metric_string

Type: string

Метрика со значением параметра

Example: example

name

Type: string

Название метрики

Example: example

negative

Type: boolean

Является ли метрика отрицательным индикатором в контексте интерпретации данных, например: процент отказов, роботов и т.д.

parameters

Type: ParamMetaExternal[]

Список параметров метрики

Example
[
  {
    "id": "example",
    "description": "example",
    "dim": "example"
  }
]

permission_scope

Type: string

Группа доступа к метрике

Example: example

require_dynamic_correction

Type: boolean

Необходима ли корректировка значения в отчете по времени

required_dimension

Type: string

Необходимая для метрики группировка

Example: example

required_keys

Type: string[]

Example
[
  "example"
]

secret

Type: boolean

Содержит секретные данные

since

Type: string

Дата появления данных для метрики

Example: example

sub_table

Type: string

Подтаблица

Example: example

support_confidence

Type: boolean

Возможен ли расчет доверия для этой метрики

type

Type: string

Тип метрики.

  • int
  • double
  • second
  • millisecond
  • affinity
  • percents
  • currency

Example: example
Example
{
  "dim": "example",
  "metric_string": "example",
  "name": "example",
  "description": "example",
  "allow_normalisation": true,
  "require_dynamic_correction": true,
  "allow_filters": true,
  "type": "example",
  "allow_sort": true,
  "default_sort": "example",
  "advanced": true,
  "support_confidence": true,
  "negative": true,
  "parameters": [
    {
      "id": "example",
      "description": "example",
      "dim": "example"
    }
  ],
  "sub_table": "example",
  "required_dimension": "example",
  "permission_scope": "example",
  "since": "example",
  "required_keys": [
    "example"
  ],
  "features": [
    "example"
  ],
  "secret": true,
  "exposes_secret_data": true
}

Meta

Метаданные запроса. Содержит описание группировок и метрик запроса.

Name

Description

dimensions

Type: DimensionMetaExternal[]

Example
[
  {
    "id": "example",
    "dim": "example",
    "name": "example",
    "short_name": "example",
    "group_name": "example",
    "description": "example",
    "type": "example",
    "disallow_by_time": true,
    "allow_filters": true,
    "parameter": {
      "id": "example",
      "description": "example",
      "dim": "example"
    },
    "fields": {},
    "allow_sort": true,
    "default_sort": "example",
    "allow_null": true,
    "sub_table": "example",
    "permission_scope": "example",
    "since": "example",
    "advanced": true,
    "required_keys": [
      "example"
    ],
    "features": [
      "example"
    ],
    "chained_attributes_group_name": "example",
    "chained_attributes_group_index": 0,
    "secret": true,
    "exposes_secret_data": true,
    "disjoint": true,
    "relations": [
      "example"
    ]
  }
]

metrics

Type: MetricMetaExternal[]

Example
[
  {
    "dim": "example",
    "metric_string": "example",
    "name": "example",
    "description": "example",
    "allow_normalisation": true,
    "require_dynamic_correction": true,
    "allow_filters": true,
    "type": "example",
    "allow_sort": true,
    "default_sort": "example",
    "advanced": true,
    "support_confidence": true,
    "negative": true,
    "parameters": [
      {
        "id": "example",
        "description": "example",
        "dim": "example"
      }
    ],
    "sub_table": "example",
    "required_dimension": "example",
    "permission_scope": "example",
    "since": "example",
    "required_keys": [
      "example"
    ],
    "features": [
      "example"
    ],
    "secret": true,
    "exposes_secret_data": true
  }
]
Example
{
  "dimensions": [
    {
      "id": "example",
      "dim": "example",
      "name": "example",
      "short_name": "example",
      "group_name": "example",
      "description": "example",
      "type": "example",
      "disallow_by_time": true,
      "allow_filters": true,
      "parameter": {
        "id": "example",
        "description": "example",
        "dim": "example"
      },
      "fields": {},
      "allow_sort": true,
      "default_sort": "example",
      "allow_null": true,
      "sub_table": "example",
      "permission_scope": "example",
      "since": "example",
      "advanced": true,
      "required_keys": [
        "example"
      ],
      "features": [
        "example"
      ],
      "chained_attributes_group_name": "example",
      "chained_attributes_group_index": 0,
      "secret": true,
      "exposes_secret_data": true,
      "disjoint": true,
      "relations": [
        "example"
      ]
    }
  ],
  "metrics": [
    {
      "dim": "example",
      "metric_string": "example",
      "name": "example",
      "description": "example",
      "allow_normalisation": true,
      "require_dynamic_correction": true,
      "allow_filters": true,
      "type": "example",
      "allow_sort": true,
      "default_sort": "example",
      "advanced": true,
      "support_confidence": true,
      "negative": true,
      "parameters": [
        null
      ],
      "sub_table": "example",
      "required_dimension": "example",
      "permission_scope": "example",
      "since": "example",
      "required_keys": [
        "example"
      ],
      "features": [
        "example"
      ],
      "secret": true,
      "exposes_secret_data": true
    }
  ]
}

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"
}

No longer supported, please use an alternative and newer version.

Предыдущая
Сравнение - drill down
Следующая
Введение