Back to all articles

Customer API – New Fields

New additional fields will shortly be added to the Customer API Overview Report calls. These have been added to bring this data in line with the data you would receive from the Overview reports on the platform.

These changes are planned for release on Saturday 15th July, 2023.

Summary of Changes 

The following new fields will be added to each of the below API calls:

  1. LearningGetCourseAudits:
    • SendCount
    • State
    • SCIMPostCode
    • SuccessStatus
  2. Policy - GetPolicyAudits:
    • SendCount
    • State
    • SCIMPostCode
  3. Survey - GetSurveyAudits:
    • SendCount
    • State
    • SCIMPostCode
  4. Phish - GetPhishAudits:
    • EmailReported
    • DeliveryStatus
    • Language
    • State
    • SCIMPostCode
    • DeliveryTime

 

Further Information

  1. LearningGetCourseAudits:
    • SendCount – The number of email alerts that have been sent to the end user.
    • State – The 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.
  2. Policy - GetPolicyAudits:
    • SendCount – The number of email alerts that have been sent to the end user.
    • State – The current state of the policy, i.e. Publish or Archive.
    • SCIMPostCode – For SCIM Provisioning customers, the end user’s postcode.
  3. Survey - GetSurveyAudits:
    • SendCount – The number of email alerts that have been sent to the end user.
    • State – The current state of the survey, i.e. Publish or Archive.
    • SCIMPostCode – For SCIM Provisioning customers, the end user’s postcode.
  4. 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 – The current state of the phish, 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.