Training Enrollments

Returns information from the User Enrollments report, which contains recently active training and user status for the past 365 days.

External Documentation

To learn more, visit the Proofpoint Security Awareness Training documentation.

Basic Parameters

Parameter	Description
Assignment Name	Filter to select one or more assignment names.
Include Deleted Users	Filter to include deleted users.
User Email Address	Filter to select one or more specific email addresses.
User First Names	Filter to select one or more specific user first names.
User Last Names	Filter to select one or more specific user last names.

Advanced Parameters

Parameter	Description
Assignment Enrollment End Date	Filter by the end date of user’s assignment enrollment date.
Assignment Enrollment Start Date	Filter by the start date of user’s assignment enrollment date.
Assignment Status	Filter to select one or more user assignment statuses. By default, all values are returned.
Enrollment Removal Reason	Filter to select one or more enrollment removal reasons. By default, all values are returned.
Include Removed Enrollments	Filter to include or exclude enrollments that have been removed from an assignment.
Manager Email Address	Filter to select users with a matching manager email address.
Page Number	Page number of the results to fetch.
Page Size	Number of results to return in each page, default is 5000.
Record Last Updated End	Filter records based on the modified or created date of a record in the data warehouse. The default value is the current date.
Record Last Updated Start	Filter records based on the modified or created date of a record in the data warehouse. The default value is one year ago from the current date.
User Tag Enable	Return users’ free value tags.
User tags	Filter on a specific free value tag.

Example Output

{
	"jsonapi": {
		"version": "3.0"
	},
	"links": {
		"self": "/api/reporting/v0.3.0/trainingenrollments?filter%5B_assignmentname%5D=%5Btest+duration%5D&filter%5B_created_start%5D=2020-01-01&page%5Bsize%5D=5&page%5Bnumber%5D=1&filter%5B_data_privacy%5D=FALSE&filter%5B_userlastname%5D=%5BActiveUserBravoLast%5D&filter%5B_userfirstname%5D=%5BActiveUserBravo%2C+ActiveUserCharlie%5D&filter%5B_created_end%5D=2020-12-01&filter%5B_filter_status%5D=%5BNot+Started%5D&filter%5B_useremailaddress%5D=%5Bactiveuserbravo%40qlikbot.testqa.com%5D"
	},
	"data": [
		{
			"type": "api_training_enrollments",
			"id": 1,
			"attributes": {
				"module_id": "fe48f81255b084a53615518da688905a",
				"userfirstname": "ActiveUserBravo",
				"userlastname": "ActiveUserBravoLast",
				"useremailaddress": "[e-mail]",
				"assignment_id": "739e7ff51389e2eb31fee93b5e9e6f6e",
				"assignmentname": "test duration",
				"assignmentstartdate": "2020-06-04T00:00:00",
				"module_enrollment_date": "2020-06-04T00:00:00",
				"module_due_date": "2020-06-14T00:00:00",
				"userassignment_completion_date_time": null,
				"userassignmentstatus": "Not Started",
				"assignmentduedate": "2020-06-14T00:00:00",
				"sso_id": null,
				"assignment_type": "Duration",
				"assignment_creation": "2020-06-02T14:51:53",
				"manageremailaddress": null,
				"is_auto_enroll": false,
				"useractiveflag": true,
				"modulename_admin": "Avoiding Dangerous Links 20.10.2",
				"modulename_user": "Avoiding Dangerous Links",
				"module_attempt_status": "Not Started",
				"usermodule_completion_date_time": null,
				"usertags": null
			}
		}
	],
	"meta": {
		"page_size": "5",
		"page_number": "1",
		"count": 1
	}
}