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

[API] Получение просмотров страницы

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

GET reports/user-events/{pr-login}/articles? startDate={start-date}&endDate={end-date}

Авторизация

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

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

Параметры пути

pr-login	type	Логин авторизованного читателя для получения информации о просмотренных им страницах. Для получения данных по анонимным пользователям вместо логина используйте - .

Параметры поискового запроса

startDate	type	Временная метка ISO 8601 даты начала диапазона отчета. Часовой пояс GMT.
endDate	type	Временная метка ISO 8601 даты окончания диапазона отчета. Часовой пояс GMT.

Образцы

Образец запроса

Copy Code

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/reports/user-events/pr1/articles?startDate=2022-08-09T02:35:00&endDate=2022-12-31T02:35:00'

Образец тела ответа

Copy Code

JSON

[
    {
        "actionType": "DirectNavigation",
        "dateTime": "2022-01-26T17:27:52",
        "href": "/api/v1/projects/deep-space-exploration/articles/basic-functionality",
        "referrerUrl": "https://docs.hedronlabs.org/articles/"
    },
    {
        "actionType": "DirectNavigation",
        "dateTime": "2022-01-26T17:27:49",
        "href": "/api/v1/projects/deep-space-exploration/articles/basic-functionality",
        "referrerUrl": "https://docs.hedronlabs.org/articles/"
    }
]

Поля ответа

actionType	Тип действия, примененного к странице. Это может быть один из следующих вариантов: DirectNavigation (непосредственная навигация) — навигация по щелчкам на ссылках. FromToc (через Дерево страниц) — страница была открыта щелчком мыши по элементу Дерева страниц. FromIndex (по ключевому слову) — страница была открыта по щелчку на ключевом слове. FromSearch (через поиск) — страница была открыта из результатов поиска. FromContextHelp (через контекстную справку) — страница была загружена в виде сниппета контекстной справки.
dateTime	Временная метка события по стандарту ISO 8601. Часовой пояс GMT.
href	URL, по которому можно получить подробную информацию о просматриваемой пользователем странице.
referrerUrl	URL страницы, с которой пользователь перешел к новой странице.

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