Get Performance Details

Description

This API endpoint can be used to get Awareness Training Mime|OS Training Module user level Performance details by Department and Performance Type (data displayed on Performance > Achievements Details).

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Awareness Training | Dashboard | Read permission.

URI

To use this endpoint you send a POST request to:

  • /api/awareness-training/company/get-performance-details

Request Headers

The following request headers must be included in your request:

Field Description
Authorization Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id

A randomly generated GUID, for example,

8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id The Application ID provided with your Registered API Application.
x-mc-date

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

{
"data": [
{
"filterBy": {
"fieldName": "String",
"value": "String"
},
"attributeIds": [
"String"
],
"searchBy": {
"fieldName": "String",
"value": "String"
}
}
]
}
data
Field Type Required Description
searchBy Filter Object Optional Search parameters used to return specific users' information. Possible values are name, email, department or customAttribute. When customAttribute is used, the attributeIds array becomes required.
attributeIds Array of String Optional A list of Mimecast secure IDs for attributes to be used when searchBy is set to custome. A maximum of 3 attribute IDs can be provided.
filterBy Filter Object Optional Allows to filter by specific video counts. The fieldName should always be set to 'type' and the value should be one of video_count_0, video_count_1, video_count_2, video_count_3, video_count_4_or_more or video_count_all. The default value is video_count_all.
Filter Object
Field Type Required Description
fieldName String Required The name of the field to search or filter based on.
value String Required The value of the field to search or filter based on.

Response

{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"numCorrect": 1,
"numNotWatched": 0,
"name": "String",
"numIncorrect": 0,
"department": "String",
"email": "String"
}
]
}
meta object
Field Type Description
status Number The function level status of the request.
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
email String The email address of the individual user.
name String The display name of the individual user.
department String The department of the individual user.
numIncorrect Number Total count of incorrectly answered video questions.
numCorrect Number Total count of correctly answered video questions.
numNotWatcehd Number Total count of videos not watched by the user.

Sample Code

Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the Global Base URL's page to find the correct base URL to use for your account.

POST {base_url}/api/awareness-training/company/get-performance-details
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json
{
"data":[
{
"attributeIds": [
"String"
],
"searchBy": {
"value": "String",
"fieldName": "String"
},
"filterBy": {
"value": "String",
"fieldName": "String"
}
}
]
}