Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns information from Knowledge Assessments.
External DocumentationTo learn more, visit the Proofpoint Security Awareness Training documentation.

​
Basic Parameters

ParameterDescription
Assignment NameFilter to select one or more assignment names.
Include Deleted AssignmentsFilter to include deleted assignments.
Include Deleted UsersFilter to include deleted users.
Include Not StartedFilter to include assignments that have not been started.
User Email AddressFilter to select one or more specific email addresses.

​
Advanced Parameters

ParameterDescription
Assessment TypeFilter to select one or more assessment types.
Assignment End DateFilter by the end date of the assignment.
Assignment Start DateFilter by the start date of the assignment.
Full QuestionFilter to return the full question copy in the results set.
Page NumberPage number of the results to fetch.
Page SizeNumber of results to return in each page, default is 5000.
Question Answered End DateFilter by the end date that the question was answered.
Question Answered Start DateFilter by the start date that the question was answered.
Record Last Updated EndFilter 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 StartFilter 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 EnableReturn users’ free value tags.
User TagsFilter on a specific free value tag.

​
Example Output

{
	"jsonapi": {
		"version": "1.0"
	},
	"links": {
		"first": "/api/reporting/v0.3.0/cyberstrength?page%5Bsize%5D=1",
		"last": "/api/reporting/v0.3.0/cyberstrength?page%5Bnumber%5D=35&page%5Bsize%5D=1",
		"next": "/api/reporting/v0.3.0/cyberstrength?page%5Bnumber%5D=2&page%5Bsize%5D=1",
		"self": "/api/reporting/v0.3.0/cyberstrength?page%5Bnumber%5D=1&page%5Bsize%5D=1"
	},
	"meta": {
		"page_number": "1",
		"page_size": "1",
		"count": 35
	},
	"data": [
		{
			"type": "fn_cyb_events_v1",
			"id": 1,
			"attributes": {
				"assignmentname": "1-17-17 C & YB Phishing - Userlist",
				"assessmentname": "Phishing",
				"assignmentstatus": "Not Started",
				"assessmentstatus": "Approved",
				"assessmenttype": "Predefined",
				"assignmentstartdate": "2017-01-17T00:00:00",
				"assignmentduedate": "2017-01-31T00:00:00",
				"assignmentdeleteddate": "9999-01-01T00:00:00",
				"userremovedfromassignment": false,
				"category": "Custom Question No Data Available",
				"categorybenchmarkall": null,
				"categorybenchmarkindustry": null,
				"questionsincategory": null,
				"isaeenabled": true,
				"attemptdate": null,
				"userfirstname": "58d72e8e4929313bdba8dc247ef3aa5f",
				"userlastname": "0bbe256b1695387f2c87f652b1d78521",
				"useremailaddress": "8238d2b693d9ad6dfab94f382064e726",
				"useractiveflag": true,
				"userdeleteddate": null,
				"userassignmentstatus": "Not Started",
				"questionid": null,
				"questiontype": "Multiple Choice",
				"iscustomquestion": true,
				"questiontext": "Custom Question",
				"selectedanswer": null,
				"correct": false,
				"secondsinattempt": "0",
				"usercorrectonassignment": null,
				"useransweredonassignment": null,
				"userscoreonassignment": null,
				"questionlatency": "0",
				"questiondate": null,
				"assignmentaveragescore": null,
				"companyaveragescore": null,
				"usertags": null,
				"sso_id": null
			}
		}
	]
}

​
Workflow Library Example

Knowledge Assessment with Proofpoint Security Awareness Training and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop