What URLs and Endpoints are needed for Results API |
Proofpoint Security Awareness Training Results API |
Depending on your production environment, you will need to use the URLs: results.(product environment0.securityeducation.com Total of 6 endpoints to configure All information is found at https://proofpoint.securityeducation.com/api/reporting/documentation/ |
QUESTION
What development information do I need to establish use of the Results API?ANSWER
Please visit the Proofpoint Security Awareness Training Results API Developer Guide for information. Note that when configuring your Results API, you will need to use the following URLs depending on your production environment:- US: results.us.securityeducation.com
- EU: results.eu.securityeducation.com
- AP: results.ap.securityeducation.com
See below for the examples of usage for each endpoint.
API Endpoints - Knowledge Assessment (Example usage)
http://host.server:port/api/reporting/v0.1.0/cyberstrength?filter[a]=b&page[number]=#&page[size]=# http://host.server:port/api/reporting/v0.1.0/cyberstrength?page[number]=2&page[size]=5&filter[_assessmenttype]=[Predefined] http://host.server:port/api/reporting/v0.1.0/cyberstrength?filter[_assignmentstartdate_start]='2016-02-02'&filter[_assignmentstartdate_end]='2016-03-02'&filter[_includenotstarted]=TRUE http://host.server:port/api/reporting/v0.1.0/cyberstrength?filter[_fullquestion]=FALSE&filter[user_tag][Department]='Marketing'&user_tag_enable http://host.server:port/api/reporting/v0.1.0/cyberstrength?filter[_assignmentname]=[1-17-17 C & YB Phishing - Userlist, 1-15-18 C & YB Phishing]&filter[_useremailaddress]=[john.doe@example.org, jane.doe@example.org]