In this guide:
Description
This API endpoint can be used to get an aggregated summary of Awareness Training Mime|OS Phishing Campaigns grouped by recipient email address.
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/phishing/campaign/get-user-data
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,
|
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,
|
Request Body
{
"data": [
{
"filterBy": [
{
"fieldName": "String",
"value": "String"
}
],
"attributeIds": [
"String"
],
"searchBy": {
"fieldName": "String",
"value": "String"
},
"id": "String"
}
]
}
data
Field | Type | Required | Description |
---|---|---|---|
id | String | Required | The Mimecast secure ID of the phishing campaing to get user data based on. The ID can be retrieved using the /api/awareness-training/phishing/campaign/get-campaign endpoint. |
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 Strings | 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 | Array of Filter Objects | Optional | Allows to filter by specific users. The fieldName should always be set to 'status' and the value should be one of sent, opened, clicked or submitted. |
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 |
---|---|---|
items | Array of User Phishing Stats Objects | Group of user-based statistics. |
User Phishing Stats Object
Field | Type | Description |
---|---|---|
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. |
timeSubmitted | Date String | Timestamp indicating when the phishing campaign message was sent in ISO 8601 format. |
timeOpened | Date String | Timestamp indicating when the user opened the message in ISO 8601 format. |
reactionTime | Number | Time in seconds between timeOpened value and timeClicked values, if the status is clicked. If status is not clicked, this field may not be present. |
numCorrectAnswers | Number | Count of correct answers for user phishing-related trainings. |
numIncorrectAnswers | Number | Count of incorrect answers for user phishing-related trainings. |
numCampaignsClicked | Number | Total number of times the user clicked on the phishing link. |
numCampaignsSent | Number | Total number of phishing campaigns sent to the user. |
numTrainingModulesAssigned | Number | Count of phishing video trainings that have been assigned to the user. |
templateName | String | Name of the phishing message template sent to the user. |
status | String | Current status of the phishing campaign for the user. Possible values are sent, opened, clicked or submitted. |
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/phishing/campaign/get-user-data
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":[
{
"id": "String",
"attributeIds": [
"String"
],
"searchBy": {
"value": "String",
"fieldName": "String"
},
"filterBy": [
{
"value": "String",
"fieldName": "String"
}
]
}
]
}
import base64
import hashlib
import hmac
import uuid
import datetime
import requests
# Setup required variables
base_url = "https://xx-api.mimecast.com"
uri = "/api/awareness-training/phishing/campaign/get-user-data"
url = base_url + uri
access_key = "YOUR ACCESS KEY"
secret_key = "YOUR SECRET KEY"
app_id = "YOUR APPLICATION ID"
app_key = "YOUR APPLICATION KEY"
# Generate request header values
request_id = str(uuid.uuid4())
hdr_date = datetime.datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S") + " UTC"
# DataToSign is used in hmac_sha1
dataToSign = ':'.join([hdr_date, request_id, uri, app_key])
# Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
hmac_sha1 = hmac.new(base64.b64decode(secret_key), dataToSign.encode(), digestmod=hashlib.sha1).digest()
# Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
sig = base64.b64encode(hmac_sha1).rstrip()
# Create request headers
headers = {
'Authorization': 'MC ' + access_key + ':' + sig.decode(),
'x-mc-app-id': app_id,
'x-mc-date': hdr_date,
'x-mc-req-id': request_id,
'Content-Type': 'application/json'
}
payload = {
'data': [
{
"id": "String",
"attributeIds": [
"String"
],
"searchBy": {
"value": "String",
"fieldName": "String"
},
"filterBy": [
{
"value": "String",
"fieldName": "String"
}
]
}
]
}
r = requests.post(url=url, headers=headers, data=str(payload))
print(r.text)
static void Main(string[] args)
{
//Setup required variables
string baseUrl = "https://xx-api.mimecast.com";
string uri = "/api/awareness-training/phishing/campaign/get-user-data";
string accessKey = "YOUR ACCESS KEY";
string secretKey = "YOUR SECRET KEY";
string appId = "YOUR APPLICATION ID";
string appKey = "YOUR APPLICATION KEY";
//Generate request header values
string hdrDate = System.DateTime.Now.ToUniversalTime().ToString("R");
string requestId = System.Guid.NewGuid().ToString();
//Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
System.Security.Cryptography.HMAC h = new System.Security.Cryptography.HMACSHA1(System.Convert.FromBase64String(secretKey));
//Use the HMAC SHA1 value to sign the hdrDate + ":" requestId + ":" + URI + ":" + appkey
byte[] hash = h.ComputeHash(System.Text.Encoding.Default.GetBytes(hdrDate + ":" + requestId + ":" + uri + ":" + appKey));
//Build the signature to be included in the Authorization header in your request
string signature = "MC " + accessKey + ":" + System.Convert.ToBase64String(hash);
//Build Request
System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(baseUrl + uri);
request.Method = "POST";
request.ContentType = "application/json";
//Add Headers
request.Headers[System.Net.HttpRequestHeader.Authorization] = signature;
request.Headers.Add("x-mc-date", hdrDate);
request.Headers.Add("x-mc-req-id", requestId);
request.Headers.Add("x-mc-app-id", appId);
//Add request body
//Create and write data to stream
string postData = @"{
""data"": [
{
""id"": ""String"",
""attributeIds"": [
""String""
],
""searchBy"": {
""value"": ""String"",
""fieldName"": ""String""
},
""filterBy"": [
{
""value"": ""String"",
""fieldName"": ""String""
}
]
}
]
}";
byte[] payload = System.Text.Encoding.UTF8.GetBytes(postData);
System.IO.Stream stream = request.GetRequestStream();
stream.Write(payload, 0, payload.Length);
stream.Close();
//Send Request
System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();
//Output response to console
System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
string responseBody = "";
string temp = null;
while ((temp = reader.ReadLine()) != null)
{
responseBody += temp;
};
System.Console.WriteLine(responseBody);
System.Console.ReadLine();
}
#Setup required variables
$baseUrl = "https://xx-api.mimecast.com"
$uri = "/api/awareness-training/phishing/campaign/get-user-data"
$url = $baseUrl + $uri
$accessKey = "YOUR ACCESS KEY"
$secretKey = "YOUR SECRET KEY"
$appId = "YOUR APPLICATION ID"
$appKey = "YOUR APPLICATION KEY"
#Generate request header values
$hdrDate = (Get-Date).ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss UTC")
$requestId = [guid]::NewGuid().guid
#Create the HMAC SHA1 of the Base64 decoded secret key for the Authorization header
$sha = New-Object System.Security.Cryptography.HMACSHA1
$sha.key = [Convert]::FromBase64String($secretKey)
$sig = $sha.ComputeHash([Text.Encoding]::UTF8.GetBytes($hdrDate + ":" + $requestId + ":" + $uri + ":" + $appKey))
$sig = [Convert]::ToBase64String($sig)
#Create Headers
$headers = @{"Authorization" = "MC " + $accessKey + ":" + $sig;
"x-mc-date" = $hdrDate;
"x-mc-app-id" = $appId;
"x-mc-req-id" = $requestId;
"Content-Type" = "application/json"}
#Create post body
$postBody = "{
""data"": [
{
""id"": ""String"",
""attributeIds"": [
""String""
],
""searchBy"": {
""value"": ""String"",
""fieldName"": ""String""
},
""filterBy"": [
{
""value"": ""String"",
""fieldName"": ""String""
}
]
}
]
}"
#Send Request
$response = Invoke-RestMethod -Method Post -Headers $headers -Body $postBody -Uri $url
#Print the response
$response
public static void main(String[] args) throws java.io.IOException, java.security.NoSuchAlgorithmException, java.security.InvalidKeyException {
//set up variables for request
String baseUrl = "https://xx-api.mimecast.com";
String uri = "/api/awareness-training/phishing/campaign/get-user-data";
String url = "https://" + baseUrl + uri;
String accessKey = "YOUR ACCESS KEY";
String secretKey = "YOUR SECRET KEY";
String appId = "YOUR APPLICATION ID";
String appKey = "YOUR APPLICATION KEY";
//create URL object
java.net.URL obj = new java.net.URL(url);
// set guid for x-mc-req-id header
String guid = java.util.UUID.randomUUID().toString();
// set date for x-mc-date header
java.text.SimpleDateFormat sdf = new java.text.SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z");
sdf.setTimeZone(java.util.TimeZone.getTimeZone("UTC"));
String date = sdf.format(new java.util.Date());
//create signature for the Authorization header
String dataToSign = date + ":" + guid + ":" + uri + ":" + appKey;
String hmacSHA1 = "HmacSHA1";
javax.crypto.spec.SecretKeySpec signingKey = new javax.crypto.spec.SecretKeySpec(org.apache.commons.codec.binary.Base64.decodeBase64(secretKey.getBytes()), hmacSHA1);
javax.crypto.Mac mac = javax.crypto.Mac.getInstance(hmacSHA1);
mac.init(signingKey);
String sig = new String(org.apache.commons.codec.binary.Base64.encodeBase64(mac.doFinal(dataToSign.getBytes())));
// create request object
javax.net.ssl.HttpsURLConnection con = (javax.net.ssl.HttpsURLConnection) obj.openConnection();
//set request type to POST
con.setRequestMethod("POST");
con.setDoOutput(true);
//add reuqest headers
con.setRequestProperty("Authorization", "MC " + accessKey + ":" + sig);
con.setRequestProperty("x-mc-req-id", guid);
con.setRequestProperty("x-mc-app-id", appId);
con.setRequestProperty("x-mc-date", date);
con.setRequestProperty("Content-Type", "application/json");
con.setRequestProperty("Accept", "application/json");
//Add post body to the request
String postBody = "{\n" +
" \"data\": [\n" +
" {\n" +
" \"id\": \"String\",\n" +
" \"attributeIds\": [\n" +
" \"String\"\n" +
" ]\n" +
" \"searchBy\": {\n" +
" \"fieldName\": \"String\",\n" +
" \"value\": \"String\",\n" +
" }\n" +
" \"filterBy\": [\n" +
" {\n" +
" \"filedName\": \"String\",\n" +
" \"value\": \"String\",\n" +
" }\n" +
" ]\n" +
" }\n" +
" ]\n" +
"}";
java.io.OutputStream os = con.getOutputStream();
os.write(postBody.getBytes("UTF-8"));
os.close();
//process response
java.io.BufferedReader in = new java.io.BufferedReader(
new java.io.InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
//return result
java.lang.System.out.println(response.toString());
}