ClickHelp User Manual

[API] Get Topic Views

Returns information on topics viewed by anonymous users or a specific user.

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

Authentication

This request requires basic authentication.

Request Parameters

Path params

user-login	type	The login of the user to get topic views for. Use - instead of the login to get the data for anonymous users.

Query params

startDate	type	An ISO 8601 timestamp of the report range start date. GMT timezone.
endDate	type	An ISO 8601 timestamp of the report range end date. GMT timezone.

Samples

Request sample

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'

Response body sample

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

Response fields

actionType	The type of the topic view action. Can be one of the following: DirectNavigation — navigation via link clicks. FromToc — the topic was opened by clicking on the TOC node. FromIndex — the topic was opened by clicking on the index keyword. FromSearch — the topic was opened from the search results. FromContextHelp — the topic was loaded as a Context Help snippet.
dateTime	An ISO 8601 timestamp of the event. GMT timezone.
href	The URL which can be used to retrieve detailed information on the topic viewed by the user.
referrerUrl	The URL of the page from which the user navigated to the topic.

[API] Get Search Queries API: Search