Retrieves multiple (upto 1,000) activity records with pagination and filtering options.
HTTP Basic authentication using your Tenant ID and API secret.
- Username is the Tenant ID (i.e.
eu-west-2_AbcdEfghI) - Password is the API secret you would have received.
You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.
OAuth 2.0 client credentials authentication.
Use the following token endpoints (replace :tenantId with your Tenant ID):
Public API access tokens
- Staging:
https://public.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://public.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://public.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://public.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
Webhooks access tokens
- Staging:
https://user.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://user.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://user.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://user.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
All access tokens must be sent using the Authorization: Bearer <access_token> header.
Scopes
For API access (non-webhooks), the following scopes are available:
api/all– Full read and write access to the API.api/read– Read-only access to the API.api/write– Write access to the API.
For webhooks, the following scopes are available:
api/webhooks– Access to webhook functionality.api/all– Full read and write access to the API, including webhooks.
Tokens must include appropriate scopes for the endpoints you wish to call.
Page number for pagination
Number of records per page
Filter by activity types (comma-separated list)
Exclude certain activity types (comma-separated list)
Filter by content IDs (comma-separated)
Filter by content type
Filter activities after this timestamp (format YYYY-MM-DD hh:mm:ss)
Filter activities before this timestamp (format YYYY-MM-DD hh:mm:ss)
Successful response
{
"pagination": {
"totalResults": 34223,
"totalPages": 1720,
"page": 1,
"pageNumber": 1,
"perPage": 20
},
"results": [
{
"id": "64b6f4a8c2e4a1b9d3f2c4a1",
"user": "64b6f4a8c2e4a1b9d3f2c4a2",
"type": "viewed",
"date": "2020-02-12T14:58:23.621Z",
"contextId": "5f9d88d6e1b2a34c56d78901",
"contextType": "content",
"contentType": "article",
"data": {}
}
]
}Details of the pagination, for endpoints that also return the deprecated pageNumber field.
Total number of results matching the query
Total number of pages available
Current page number
Number of results per page
Deprecated alias for page, carrying the same value. Use page instead; pageNumber will be removed in a future release.
The type of activity being logged
Unique ID for this activity record
User ID for the user who triggered this activity record
Timestamp when the activity occurred
Unique identifier for the context item
The kind of record this activity was logged against, such as content. Describes the subject of the activity rather than the artifact itself; see contentType for that.
The kind of artifact the activity relates to, such as video or pathway. Describes the artifact itself, where contextType describes what the activity was recorded against.
Unstructured JSON object with variable content depending on the type of activity. For example, a viewed statement will list the duration of the view and the source, whereas a found statement will detail the keyword of the search and results count.
Bad Request. Returned when the query could not be processed. The body is a plain-text error message rather than the JSON error object used elsewhere in this API.
Unauthorized
Unauthorized
Not Found
Not found
Unprocessable Content
Unprocessable Content