Документерра: руководство пользователя

[API] Получение поисковых запросов

Получение информации о поисковых запросах анонимных пользователей или конкретного авторизованного читателя.

GET reports/user-events/{pr-login}/search-queries? startDate={start-date}&endDate={end-date}&projectId={publication-id}

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути
pr-login string
Логин авторизованного читателя для получения поисковых запросов. Для получения данных по анонимным пользователям вместо логина используйте - .
Параметры поискового запроса
startDate string
Временная метка ISO 8601 даты начала диапазона отчета. Часовой пояс GMT.
endDate string
Временная метка ISO 8601 даты окончания диапазона отчета. Часовой пояс GMT.
projectId
string
[опционально] Идентификатор публикации, по которой необходимо получить статистику поисковых запросов.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/reports/user-events/pr1/search-queries?startDate=2022-08-09T02:35:00&endDate=2022-12-31T02:35:00?projectID=project-deep-space-exploration'
Образец тела ответа
JSON
[
{
"dateTime": "2022-11-07T15:25:34",
"queryText": "click",
"resultsTotal": 5,
"projectId": "deep-space-exploration-publication"
},
{
"dateTime": "2022-11-07T15:25:27",
"queryText": "nebula",
"resultsTotal": 0,
"projectId": "deep-space-exploration-publication"
},
{
"dateTime": "2022-11-07T15:25:22",
"queryText": "some",
"resultsTotal": 0,
"projectId": "deep-space-exploration-publication"
}
]

Поля ответа

dateTimeВременная метка события по стандарту ISO 8601. Часовой пояс GMT.
queryTextПолнотекстовый поисковый запрос.
resultsTotal
Общее количество полученных результатов поиска.
projectId
Идентификатор публикации, по которой проводился поиск