Документация
Справочник разработчика
API управления
Управление клиентами Директа
API отчетов v1
Группировки
Клики
Параметры посетителей

Запрос к API

Ниже описаны параметры, которые могут входить в запрос к API. Ответ возвращается в кодировке UTF-8 в виде JSON-файла.

Краткое содержание

Синтаксис запроса

GET https://api-metrika.yandex.ru/analytics/v3/data/ga ? 
end-date
[no-highlight[

Дата окончания отчетного периода.

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

]no-highlight]
=<string> & ids
[no-highlight[Номер счетчика, данные которого необходимо получить. Перед номером счетчика необходимо указать префикс ga:.]no-highlight]
=<string> & metrics
[no-highlight[

Метрики позволяют получать данные о статистике посещаемости и активности пользователей сайта.

Если в запросе вы не укажете ни одной группировки, то API вернет общее значение метрики для выбранного временного интервала без разделения его на какие-либо группы.

Обратите внимание на следующие особенности:

  • В состав одного запроса может входить не более 10 метрик.
  • Большинство метрик можно использовать в сочетании друг с другом при условии, что не выбрана ни одна группировка.
  • Не все метрики можно сочетать с другими метриками и группировками в составе одного запроса.
]no-highlight]
=<string> & start-date
[no-highlight[

Дата начала отчетного периода.

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

Примечание. 

Относительные временные значения привязаны к часовому поясу, установленному в вашей учетной записи Яндекс.Метрики.

]no-highlight]
=<string> & [callback
[no-highlight[Callback. Если указан, результат будет обернут в вызов callback(...);]no-highlight]
=<string>] & [dimensions
[no-highlight[

Группировки объединяют данные по критериям.

Например, используйте параметр dimensions=ga:browser,ga:city, чтобы:

  1. Получить данные по количеству посещений.
  2. Сгруппировать эти данные по браузеру, который использовал посетитель и городу, в котором находился посетитель в момент посещения.

Если по указанной группировке данные не были получены, возвращается значение (not set).

Обратите внимание на следующие ограничения:

  • В состав одного запроса может входить не более 7 группировок.
  • Запрос не может состоять только из группировок, но должен содержать хотя бы одну метрику.
  • Не все группировки можно сочетать друг с другом в составе одного запроса.
]no-highlight]
=<string>] & [filters
[no-highlight[

Фильтр позволяет ограничить данные, возвращаемые в результате запроса.

Обратите внимание на следующие особенности:

  • Фильтрация по группировке производится до использования группировок. Таким образом результирующая метрика представляет собой итоговое значение только для данных, удовлетворяющих условию группировки.
  • Фильтрация по метрике производится после использования метрик.
  • Вы можете использовать для фильтрации те группировки и метрики, которые не входят в состав вашего запроса.
]no-highlight]
=<string>] & [max-results
[no-highlight[

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

Используйте данный параметр в сочетании с параметром start-index, чтобы получить подмножество элементов, первый из которых соответствует значению указанному в параметре start-index.

По умолчанию параметр принимает значение 100. Максимально допустимое число строк равно 10000.

Количество строк в отчете может быть меньше, чем вы указали, если для выбранного сегмента нет достаточного количества записей. Например, для группировки ga:country вы сможете получить не больше 300 записей.

]no-highlight]
=<int>] & [samplingLevel
[no-highlight[Используйте данный параметр для указания уровня семплирования (количества визитов, использованных при расчете итогового значения).

Значение по умолчанию: DEFAULT

Допустимые значения:

  • HIGHER_PRECISION — возвращает наиболее точное значение, используя наибольшую выборку данных. Этот режим может потребовать дополнительное время и замедлить обработку запроса.
  • FASTER — возвращает быстрый результат на основе сокращенной выборки данных.
  • DEFAULT — возвращает результат на основе выборки, сочетающей скорость и точность данных.
]no-highlight]
=<g_a_sample_accuracy>] & [sort
[no-highlight[

В качестве сортировки собранных данных может быть использован список метрик и группировок.

По умолчанию используется сортировка по возрастанию. Чтобы использовать сортировку по убыванию, укажите знак «-» в запросе перед списком метрик и группировок.

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

]no-highlight]
=<string>] & [start-index
[no-highlight[

По умолчанию данный параметр принимает значение 1.

Используйте этот параметр в сочетании с параметром max-results для тех случаев, когда количество элементов списка totalResults превышает, к примеру, 10000, а вам нужно получить 10001 значение.

Примечание. 

Параметр start-index отсчитывается от 1, а не от 0.

Значение по умолчанию: 1

]no-highlight]
=<integer>]
end-date

Дата окончания отчетного периода.

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

idsНомер счетчика, данные которого необходимо получить. Перед номером счетчика необходимо указать префикс ga:.
metrics

Метрики позволяют получать данные о статистике посещаемости и активности пользователей сайта.

Если в запросе вы не укажете ни одной группировки, то API вернет общее значение метрики для выбранного временного интервала без разделения его на какие-либо группы.

Обратите внимание на следующие особенности:

  • В состав одного запроса может входить не более 10 метрик.
  • Большинство метрик можно использовать в сочетании друг с другом при условии, что не выбрана ни одна группировка.
  • Не все метрики можно сочетать с другими метриками и группировками в составе одного запроса.
start-date

Дата начала отчетного периода.

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

Примечание. 

Относительные временные значения привязаны к часовому поясу, установленному в вашей учетной записи Яндекс.Метрики.

callbackCallback. Если указан, результат будет обернут в вызов callback(...);
dimensions

Группировки объединяют данные по критериям.

Например, используйте параметр dimensions=ga:browser,ga:city, чтобы:

  1. Получить данные по количеству посещений.
  2. Сгруппировать эти данные по браузеру, который использовал посетитель и городу, в котором находился посетитель в момент посещения.

Если по указанной группировке данные не были получены, возвращается значение (not set).

Обратите внимание на следующие ограничения:

  • В состав одного запроса может входить не более 7 группировок.
  • Запрос не может состоять только из группировок, но должен содержать хотя бы одну метрику.
  • Не все группировки можно сочетать друг с другом в составе одного запроса.
filters

Фильтр позволяет ограничить данные, возвращаемые в результате запроса.

Обратите внимание на следующие особенности:

  • Фильтрация по группировке производится до использования группировок. Таким образом результирующая метрика представляет собой итоговое значение только для данных, удовлетворяющих условию группировки.
  • Фильтрация по метрике производится после использования метрик.
  • Вы можете использовать для фильтрации те группировки и метрики, которые не входят в состав вашего запроса.
max-results

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

Используйте данный параметр в сочетании с параметром start-index, чтобы получить подмножество элементов, первый из которых соответствует значению указанному в параметре start-index.

По умолчанию параметр принимает значение 100. Максимально допустимое число строк равно 10000.

Количество строк в отчете может быть меньше, чем вы указали, если для выбранного сегмента нет достаточного количества записей. Например, для группировки ga:country вы сможете получить не больше 300 записей.

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

Значение по умолчанию: DEFAULT

Допустимые значения:

  • HIGHER_PRECISION — возвращает наиболее точное значение, используя наибольшую выборку данных. Этот режим может потребовать дополнительное время и замедлить обработку запроса.
  • FASTER — возвращает быстрый результат на основе сокращенной выборки данных.
  • DEFAULT — возвращает результат на основе выборки, сочетающей скорость и точность данных.
sort

В качестве сортировки собранных данных может быть использован список метрик и группировок.

По умолчанию используется сортировка по возрастанию. Чтобы использовать сортировку по убыванию, укажите знак «-» в запросе перед списком метрик и группировок.

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

start-index

По умолчанию данный параметр принимает значение 1.

Используйте этот параметр в сочетании с параметром max-results для тех случаев, когда количество элементов списка totalResults превышает, к примеру, 10000, а вам нужно получить 10001 значение.

Примечание. 

Параметр start-index отсчитывается от 1, а не от 0.

Значение по умолчанию: 1

Формат ответа


{
    "kind
[no-highlight[

Описание

Отображает тип ресурса. Параметр всегда принимает значение analytics#gaData.

]no-highlight]
" : < string > , "id
[no-highlight[

Описание

Отображает идентификатор запроса.

]no-highlight]
" : < string > , "selfLink
[no-highlight[

Описание

Отображает ссылку на данный запрос.

]no-highlight]
" : < string > , "containsSampledData
[no-highlight[

Описание

Определяет использовалось ли семплирование при сборе данных. Если использовалось, принимает значение true.

]no-highlight]
" : < boolean > , "sampleSize
[no-highlight[

Описание

Отображает размер выборки, использованной для получения результата запроса с семплированием.

]no-highlight]
" : < string > , "sampleSpace
[no-highlight[

Описание

Отображает общий объем данных, доступный для осуществления выборки при использовании семплирования.

]no-highlight]
" : < string > , "query
[no-highlight[

Описание

Включает в себя все параметры, переданные в запросе.

]no-highlight]
" : { "start-date
[no-highlight[

Описание

Отображает дату начала отчетного периода.

]no-highlight]
" : < string > , "end-date
[no-highlight[

Описание

Отображает дату окончания отчетного периода.

]no-highlight]
" : < string > , "dimensions
[no-highlight[

Описание

Отображает список группировок запроса.

]no-highlight]
" : [ < string > , ... ], "metrics
[no-highlight[

Описание

Отображает список метрик запроса.

]no-highlight]
" : [ < string > , ... ], "sort
[no-highlight[

Описание

Отображает список метрик и группировок, по которым отсортированы данные.

]no-highlight]
" : [ < string > , ... ], "filters
[no-highlight[

Описание

Отображает список фильтров по метрикам и группировкам.

]no-highlight]
" : < string > , "start-index
[no-highlight[

Описание

Отображает индекс первой записи из запроса.

]no-highlight]
" : < integer > , "max-results
[no-highlight[

Описание

Отображает максимальное количество строк на странице.

]no-highlight]
" : < integer > }, "itemsPerPage
[no-highlight[

Описание

Отображает количество данных, которые отображаются на странице. По умолчанию максимальное количество данных равно 1000.

]no-highlight]
" : < integer > , "totalResults
[no-highlight[

Описание

Отображает общее количество результатов.

]no-highlight]
" : < integer > , "columnHeaders
[no-highlight[

Описание

Отображает заголовки столбцов, содержащих список группировок и метрик. Общее количество этих столбцов составляет общую сумму группировок и метрик, используемых в запросе.

]no-highlight]
" : [ { "name
[no-highlight[

Описание

Содержит название группировки или метрики

]no-highlight]
" : < string > , "columnType
[no-highlight[

Описание

Содержит тип атрибута. Принимает значения: dimension или metric.

]no-highlight]
" : < string > , "dataType
[no-highlight[

Описание

Содержит тип данных. Для столбца с группировками данный параметр всегда принимает значение STRING.

]no-highlight]
" : < string > }, ... ], "totalsForAllResults
[no-highlight[

Описание

Отображает итоговые значения запрошенных метрик, представленные в виде пар: название метрики и ее значения.

]no-highlight]
" : { "key_1" : < string > , "key_2" : ... }, "rows
[no-highlight[

Описание

Отображает список строк, каждая из которых содержит измерения и метрики. Порядок данных соответствует порядку, указанному в запросе.

]no-highlight]
" : [ [ < string > , ... ], ... ] }
ПараметрыОписание
kind Отображает тип ресурса. Параметр всегда принимает значение analytics#gaData.
id Отображает идентификатор запроса.
selfLink Отображает ссылку на данный запрос.
containsSampledData Определяет использовалось ли семплирование при сборе данных. Если использовалось, принимает значение true.
sampleSize Отображает размер выборки, использованной для получения результата запроса с семплированием.
sampleSpace Отображает общий объем данных, доступный для осуществления выборки при использовании семплирования.
query Включает в себя все параметры, переданные в запросе.
itemsPerPage Отображает количество данных, которые отображаются на странице. По умолчанию максимальное количество данных равно 1000.
totalResults Отображает общее количество результатов.
columnHeaders Отображает заголовки столбцов, содержащих список группировок и метрик. Общее количество этих столбцов составляет общую сумму группировок и метрик, используемых в запросе.
totalsForAllResults Отображает итоговые значения запрошенных метрик, представленные в виде пар: название метрики и ее значения.
rows Отображает список строк, каждая из которых содержит измерения и метрики. Порядок данных соответствует порядку, указанному в запросе.
query
start-date Отображает дату начала отчетного периода.
end-date Отображает дату окончания отчетного периода.
dimensions Отображает список группировок запроса.
metrics Отображает список метрик запроса.
sort Отображает список метрик и группировок, по которым отсортированы данные.
filters Отображает список фильтров по метрикам и группировкам.
start-index Отображает индекс первой записи из запроса.
max-results Отображает максимальное количество строк на странице.
columnHeaders
name Содержит название группировки или метрики
columnType Содержит тип атрибута. Принимает значения: dimension или metric.
dataType Содержит тип данных. Для столбца с группировками данный параметр всегда принимает значение STRING.