Checkpoint assessments feed reference

James Lett

Updated 27 August 2026 14:52

The checkpoint assessments feed provides read-only access to checkpoint assessment results for learners across all programmes. You can use it to pull scores, outcomes, completion data, and checkpoint type into your own reporting alongside other Aptem data.

This page covers the fields the feed returns, the query options you can use, and how it links to other feeds. For general information about OData v2, see Introduction to OData v2. For a full explanation of how query options work, see How to query OData v2 feeds.

Fields

Field	Type	Description
`Id`	Integer	Row identifier
`CheckpointId`	Integer	The identifier of the checkpoint definition
`CheckpointName`	String	The name of the checkpoint
`LearnerUniqueId`	UUID	The unique identifier of the learner who took the checkpoint. A follow-up release will also include a numeric `LearnerId` matching the Users v1 feed.
`ProgrammeId`	Integer	The identifier of the programme the checkpoint belongs to
`CheckpointType`	String	How the checkpoint was triggered (see checkpoint types below)
`Status`	String	The current status of the checkpoint (see statuses below)
`QuestionsCount`	Integer	The total number of questions in the checkpoint
`Score`	Integer	The learner's score for the checkpoint
`CorrectAnswersCount`	Integer	The number of questions the learner answered correctly
`CreatedDate`	DateTimeOffset	The date and time the checkpoint was created
`CompletedDate`	DateTimeOffset	The date and time the checkpoint was completed. Null if not yet completed.
`CheckpointEndDate`	DateTimeOffset	The deadline by which the checkpoint must be completed
`TimeSpent`	Integer	The time the learner spent on the checkpoint, in seconds
`LastModifiedDate`	DateTimeOffset	The date and time the checkpoint record was last updated

Statuses

The Status field returns one of the following values (additional values may exist):

Status	Description
`Completed`	The learner has completed the checkpoint

Check the interactive documentation at /odata/2.0/docs on your tenant for the complete set.

Checkpoint types

The CheckpointType field indicates how the checkpoint was triggered. Known values include:

Type	Description
`PeriodicGeneration`	Generated at regular intervals based on a schedule

Check the interactive documentation at /odata/2.0/docs on your tenant for the complete set.

Querying the feed

The checkpoint assessments feed supports the same query options as other v2 feeds:

Option	What it does	Example
`$select`	Return only the fields you specify	`$select=CheckpointName,Score,Status`
`$top`	Return only the first N items	`$top=50`
`$count`	Include the total count of matching items	`$count=true`

Some fields may not support $filter or $orderby.

Check the interactive documentation at /odata/2.0/docs on your tenant, or the Actions feed reference for an example of how restrictions work.

For a detailed explanation of each option and how to use them in the browser and Excel, see How to query OData v2 feeds. For ready-made query examples, see Checkpoint assessments query examples.

Filter operators

Operator	Meaning	Example
`eq`, `ne`	Equals, not equals	`Status eq 'Completed'`
`gt`, `ge`, `lt`, `le`	Greater/less than (or equal)	`Score ge 80`
`and`, `or`, `not`	Combine clauses	`Status eq 'Completed' and Score ge 80`

Example queries

All completed checkpoints, sorted by completion date (most recent first):

/odata/2.0/CheckpointAssessments?$filter=Status eq 'Completed'&$orderby=CompletedDate

Checkpoints for a specific programme:

/odata/2.0/CheckpointAssessments?$filter=ProgrammeId eq 4501

Completed checkpoints with a score of 80 or above:

/odata/2.0/CheckpointAssessments?$filter=Status eq 'Completed' and Score ge 80&$select=CheckpointName,LearnerUniqueId,Score,CorrectAnswersCount,QuestionsCount

Checkpoints created in the last 30 days:

/odata/2.0/CheckpointAssessments?$filter=CreatedDate ge 2026-07-25T00:00:00Z&$orderby=CreatedDate

Count of completed checkpoints:

/odata/2.0/CheckpointAssessments?$filter=Status eq 'Completed'&$count=true&$top=0

Results are always paged. Each page returns up to 1,000 items. When more items are available, the response includes an @odata.nextLink field containing the URL of the next page.

To read through a full result set, follow the @odata.nextLink until it is no longer present in the response. Do not build your own paging by incrementing $skip, as this can miss or duplicate items if data changes between requests.

Linking to v1 feeds

The initial release uses LearnerUniqueId (a GUID) rather than the numeric LearnerId used in v1 feeds. This means you cannot directly join checkpoint assessments to the Users v1 feed by learner ID in the first release. A follow-up release will add a numeric LearnerId field to enable this join, giving you access to learner name, programme details, case owner, and other profile data.

Using the checkpoint assessments feed in Excel

The checkpoint assessments feed connects the same way as the actions feed. Query the feed URL directly with your field selection in the URL.

Example Power Query M code:

let Source = OData.Feed( "https://yourtenant.aptem.co.uk/odata/2.0/CheckpointAssessments?$select=Id,CheckpointId,CheckpointName,LearnerUniqueId,ProgrammeId,CheckpointType,Status,QuestionsCount,Score,CorrectAnswersCount,CreatedDate,CompletedDate,CheckpointEndDate,TimeSpent,LastModifiedDate", [#"X-API-Token"="YOUR_API_KEY"], [Implementation="2.0"] ) in Source

Getting help

If you have questions about the checkpoint assessments feed or need your API key:

Contact your Implementation Consultant if you are still in implementation
Contact your Customer Success Manager if you are a live customer
Raise a support ticket