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,
"perPage": 20
},
"results": [
{
"id": "64b6f4a8c2e4a1b9d3f2c4a1",
"user": "64b6f4a8c2e4a1b9d3f2c4a2",
"type": "viewed",
"date": "2020-02-12T14:58:23.621Z",
"contextId": "5f9d88d6e1b2a34c56d78901",
"contextType": "content",
"data": {},
"with": null
}
]
}Details of the pagination
Total number of results matching the query
Total number of pages available
Current page number
Number of results per page
Unique identifier for the content
Title of the content
Detailed description of the content, may contain HTML
List of tags associated with this content
The kind of artifact associated with this content record
Timestamp when the content was created
Timestamp when the content was last updated
User ID who authored this content. Nullable for auto-curated content.
Whether the content has been recognized for its importance or validity by the customer organization