Get a single activity record

Prev Next
Get
/activity/{id}

Retrieves a specific activity by its ID

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

Path parameters
id
stringRequired

Unique identifier of the activity

Pattern^[0-9a-fA-F]{24}$
Example507f1f77bcf86cd799439012
Responses
200

Successful response

{
  "id": "60d5ec49b60b4b3a2c8f9a10",
  "user": "60d5ec49b60b4b3a2c8f9a11",
  "type": "viewed",
  "date": "2020-02-12T14:58:23.621Z",
  "contextId": "64b6f4a8c2e4a1b9d3f2c4a0",
  "contextType": "content",
  "data": {
    "source": {
      "source": "feed"
    },
    "duration": "3600"
  },
  "with": null
}
Expand All
object
type
string

The type of activity being logged

Valid values[ "viewed", "completed", "passed", "pinned", "unpinned", "liked", "unliked", "commented", "commentdeleted", "shared", "progressed", "registered", "followed", "unfollowed", "started", "resumed", "searched", "found", "loggedin", "loggedout" ]
Max length250
Examplefile
name
string

The name of the activity logged

Max length250
ExampleRelative Time Dilation - Practical Guide
id
string

Unique ID for this activity record

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

User ID for the user who triggered this activity record

Pattern^[0-9a-fA-F]{24}$
date
string (date-time)

Timestamp when the activity occurred

contextId
string

Unique identifier for the context item

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

What this activity was in relation to

Examplecontent
data
object

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.

with
object | null

Additional context information (nullable)

404

Activity not found