Get instant support with our search!
Customer API – New fields
We’ve introduced additional fields to the Customer API Overview Report calls to align the data more closely with what is available in the platform’s Overview reports.
Summary of changes
The following new fields will be added to each of the below API calls:
- Learning – GetCourseAudits:
- SendCount
- State
- SCIMPostCode
- SuccessStatus
- Policy - GetPolicyAudits:
- SendCount
- State
- SCIMPostCode
- Survey - GetSurveyAudits:
- SendCount
- State
- SCIMPostCode
- Phish - GetPhishAudits:
- EmailReported
- DeliveryStatus
- Language
- State
- SCIMPostCode
- DeliveryTime
Further Information
- Learning – GetCourseAudits:
- SendCount – Number of email alerts sent to the end user.
- State – Current state of the course, i.e. Publish or Archive.
- SCIMPostCode – For SCIM Provisioning customers, the end user’s postcode.
- SuccessStatus – For SCORM courses, additional information on the course status per user.
- Policy - GetPolicyAudits:
- SendCount – Number of email alerts sent to the end user.
- State – Current state of the policy, i.e. Publish or Archive.
- SCIMPostCode – For SCIM Provisioning customers, the end user’s postcode.
- Survey - GetSurveyAudits:
- SendCount – Number of email alerts sent to the end user.
- State – Current state of the survey, i.e. Publish or Archive.
- SCIMPostCode – For SCIM Provisioning customers, the end user’s postcode.
- Phish - GetPhishAudits:
- EmailReported – Information on whether the user reported the email via the MetaCompliance Phish plugin.
- DeliveryStatus – Delivery result of email to the user - Delivered, Bounced or Dropped.
- Language – The language of the email sent to the user.
- State – Current state of the phish, i.e. Publish or Archive.
- SCIMPostCode – For SCIM Provisioning customers, the end user’s postcode.
- DeliveryTime – The time at which the phish was delivered to the user.
This information has been shared to help you prepare for these new updates; however, you may not need to take any action.