Query activity records

Prev Next
Get
/activities

Retrieves multiple (upto 1,000) activity records with pagination and filtering options.

Security
HTTP
Type basic

To pass the authentication step you will need to provide the following:

Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received

Query parameters
page
integer

Page number for pagination

Minimum1.0
Default1
Example1
perPage
integer

Number of records per page

Minimum1.0
Maximum1000.0
Default20
Example20
actions
string

Filter by activity types (comma-separated list)

Exampleviewed,completed
omitActions
string

Exclude certain activity types (comma-separated list)

Exampleviewed,loggedin
contentIds
string

Filter by content IDs (comma-separated)

Example000000000000000000000001,000000000000000000000002
contentType
string

Filter by content type

Examplecontent
timestampFrom
string

Filter activities after this timestamp (format YYYY-MM-DD hh:mm:ss)

Example2020-01-01 00:00:00
timestampTo
string

Filter activities before this timestamp (format YYYY-MM-DD hh:mm:ss)

Example2020-10-01 00:00:00
Responses
200

Successful response

{
  "pagination": {
    "totalResults": 34223,
    "totalPages": 1720,
    "page": 1,
    "perPage": 20
  },
  "results": [
    {
      "id": "64b6f4a8c2e4a1b9d3f2c4a1",
      "user": "64b6f4a8c2e4a1b9d3f2c4a2",
      "type": "viewed",
      "date": "2020-02-12T14:58:23.621Z",
      "contextId": "5f9d88d6e1b2a34c56d78901",
      "contextType": "content",
      "data": {},
      "with": null
    }
  ]
}
Expand All
object
pagination
object (Pagination)

Details of the pagination

totalResults
integer

Total number of results matching the query

Example48
totalPages
integer

Total number of pages available

Example3
page
integer

Current page number

Minimum1.0
Default1
Example1
perPage
integer

Number of results per page

Minimum1.0
Maximum1000.0
Default100
Example20
results
Array of object (Content)
object
id
string

Unique identifier for the content

Pattern^[0-9a-fA-F]{24}$
Example5c8936159ec2d00010cdd334
title
string

Title of the content

Max length255
ExampleAn amazing video
description
string

Detailed description of the content, may contain HTML

Max length65536
ExampleThis content looked really interesting and relevant to recent conversations in the development team
tags
Array of string

List of tags associated with this content

string
Max length255
Examplelearning
type
string

The kind of artifact associated with this content record

Max length24
Examplevideo
createdAt
string (date-time)

Timestamp when the content was created

Example2019-03-13T16:15:24Z
updatedAt
string (date-time)

Timestamp when the content was last updated

Example2019-03-13T16:15:24Z
author
string | null

User ID who authored this content. Nullable for auto-curated content.

Pattern^[0-9a-fA-F]{24}$
Example5c8936159ec2d00010cdd334
isOfficial
boolean

Whether the content has been recognized for its importance or validity by the customer organization

Exampletrue