Query CPD entries

Prev Next
Get
/cpdEntries

Retrieves multiple CPD entries (up to 1,000 per page) with pagination and date filtering

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
Default100
Example20
entryDateFrom
string

Filter entries after this date (format YYYY-MM-DD hh:mm:ss)

Example2020-09-25
entryDateTo
string

Filter entries before this date (format YYYY-MM-DD hh:mm:ss)

Example2020-11-01
Responses
200

Successful response

{
  "pagination": {
    "totalResults": 48,
    "totalPages": 3,
    "page": 1,
    "perPage": 20
  },
  "results": [
    {
      "logEntryId": "60d5ec49b60b4b3a2c8f9a10",
      "userId": "60d5ec49b60b4b3a2c8f9a11",
      "activity": {
        "type": "file",
        "name": "International Space Station after undocking of STS 132"
      },
      "category": {
        "categoryId": "64b6f4a8c2e4a1b9d3f2c4a0",
        "name": "TECHNOLOGY"
      },
      "entryDate": "2020-09-25T19:34:23.133Z",
      "durationMinutes": 15,
      "description": null,
      "isVerified": true
    },
    {
      "logEntryId": "64b6f4a8c2e4a1b9d3f2c4a1",
      "userId": "64b6f4a8c2e4a1b9d3f2c4a2",
      "activity": {
        "type": "file",
        "name": "International Space Station after undocking of STS 132"
      },
      "category": {
        "categoryId": "5f9d88d6e1b2a34c56d78901",
        "name": "TECHNOLOGY"
      },
      "entryDate": "2020-09-20T14:21:22.222Z",
      "durationMinutes": 15,
      "description": null,
      "isVerified": true
    }
  ]
}
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 (CPDEntry)
object
logEntryId
string

Unique ID for this activity record

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

User ID for the user who triggered this activity record

Pattern^[0-9a-fA-F]{24}$
Example5c8936159ec2d00010cdd334
activity
object (Activity)
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)

category
object (CPDCategory)
categoryId
string

Unique ID for this category record

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

Name of the category of CPD activity

Max length250
ExamplePersonal Reading
entryDate
string (date-time)

The date and time the CPD entry was logged

Example2020-09-25T19:34:23.133Z
durationMinutes
integer

Minutes logged as CPD from this activity

Minimum0.0
Example15
description
string | null

Summary or reflective statement

Max length65536
ExampleI realised we could be more productive if travelling close to the speed of light.
isVerified
boolean

Whether or not this activity was determined by user submission or generated based upon verified activity in the system

Exampletrue