Reports

Reports

Endpoints for retrieving analytics and user event data.

Reports Endpoints

Get user search queries report

Returns a history of search queries made by a specific user, or by anonymous users.

Path Parameters
  • userLogin
    string
    required

    The login of the user.

Query Parameters
  • startDate
    string date-time
    required

    An ISO 8601 timestamp for the start of the report range (GMT).

  • endDate
    string date-time
    required

    An ISO 8601 timestamp for the end of the report range (GMT).

  • projectId
    string

    An optional ID of a project or publication to filter the report.

Responses
GET/reports/user-events/{userLogin}/search-queries
curl https://your-portal.clickhelp.co/api/v1/reports/user-events//search-queries \
  --header 'Authorization: Basic username:password'

[
  {
    "dateTime": "2026-01-23T22:10:04.180Z",
    "queryText": "…",
    "resultsTotal": 1,
    "projectId": "…"
  }
]

A list of search query events.

Get topic views report

Returns a history of topic view events for a specific user, or for anonymous users if '{userLogin}' is '-'.

Path Parameters
  • userLogin
    string
    required

    The login of the user.

Query Parameters
  • startDate
    string date-time
    required

    An ISO 8601 timestamp for the start of the report range (GMT).

  • endDate
    string date-time
    required

    An ISO 8601 timestamp for the end of the report range (GMT).

Responses
GET/reports/user-events/{userLogin}/articles
curl https://your-portal.clickhelp.co/api/v1/reports/user-events//articles \
  --header 'Authorization: Basic username:password'

[
  {
    "actionType": "DirectNavigation",
    "dateTime": "2026-01-23T22:10:04.180Z",
    "href": "…",
    "referrerUrl": "https://example.com"
  }
]

A list of topic view events.