Query CPD user summaries

Prev Next
Get
/cpdUserLogSummaries

Retrieves CPD summaries (up to 1,000 per page) for users with filtering by date and user IDs

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
userIds
string

Comma-separated list of user IDs to filter by

Example5c9de5c64a6b1c37a58e393c,5cadda57f4a0f40010af03de
page
integer

Page number for pagination

Minimum1.0
Default1
Example1
perPage
integer

Number of records per page

Minimum1.0
Maximum1000.0
Default100
Example5
entryDateFrom
stringRequired

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

Example2020-11-17T09:50:00
entryDateTo
stringRequired

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

Example2021-11-17T09:51:00
Responses
200

Successful response

{
  "pagination": {
    "totalResults": 2,
    "totalPages": 1,
    "page": 1,
    "perPage": 100
  },
  "results": [
    {
      "userId": "5c9de5c64a6b1c37a58e393c",
      "durationMinutes": 360
    },
    {
      "userId": "5cadda57f4a0f40010af03de",
      "durationMinutes": 620
    }
  ]
}
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 (CPDUserSummary)
object
userId
string

ID of the user this summary is for

Pattern^[0-9a-fA-F]{24}$
Example5c9de5c64a6b1c37a58e393c
durationMinutes
integer

Total CPD minutes logged by the user within the specified time period

Minimum0.0
Example360