Get Campaigns

Description

This API endpoint can be used to get all campaign-level information on Awareness Training Mime|OS Training Campaigns created, both pending and launched. (Data displayed on Modules > Campaigns)

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 endpont you send a POST request to:

  • /api/awareness-training/campaign/get-campaigns

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": []
}

Response

{
 "fail": [], 
 "meta": {
  "status": 200
 }, 
 "data": [
  {
   "campaigns": [
    {
     "percentCorrect": 50, 
     "percentComplete": 100, 
     "locked": true, 
     "numCorrectAnswers": {
      "forQuestion3": 2, 
      "forQuestion2": 1, 
      "forQuestion1": 4
     }, 
     "id": "Sting", 
     "numCompleted": 5, 
     "allOtherCampaigns": {
      "numCorrectAnswers": 5, 
      "numCampaigns": 1, 
      "numComplete": 2, 
      "numSent": 4
     }, 
     "group": {
      "description": "Sting", 
      "source": "Sting", 
      "folderCount": 1, 
      "parentId": "Sting", 
      "id": "Sting", 
      "userCount": 5
     }, 
     "name": "Sting", 
     "title": {
      "defaultGifs": {
       "correctGif": "Sting", 
       "incorrectGif": "Sting"
      }, 
      "titleForCustomModule": false, 
      "correctAnswers": {
       "forQuestion3": 1, 
       "forQuestion2": 3, 
       "forQuestion1": 4
      }, 
      "id": "Sting", 
      "title": "Sting"
     }, 
     "createDate": "Date Sting", 
     "numSent": 5, 
     "emailCustomized": false, 
     "launchDate": "Date Sting", 
     "emailMsg": {
      "body": "Sting", 
      "subject": "Sting"
     }
    }
   ]
  }
 ]
}
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
campaigns Campaigns Object An object containing data about each campaign.
Campaign Object
Field Type Description
id String The Mimecast secure ID of the campaign.
name String The name of the Awareness Training campaign.
title Title Object An object containing information about the campaign title
group Group Object An object containing information about the applied group.
launchDate Date String Timestamp indicating when the campaign was set to be launched, in ISO 8601 format.
createDate Date String Timestamp indicating when the campaign was created, in ISO 8601 format.
emailCustomized Boolean Identifies if the email alert going to assinged users was modified from the template.
emailMsg Email Message Object An object containing the email message sent to assigned users.
numSent Number Count showing the number of emails sent out to assigned users of the campaign.
numCompleted Number Count showing the number of users that have completed the campaign.
allOtherCampaigns Campaigns Statistics Object An object showing counts of other campaigns combined for comparison to this campaign.
locked Boolean Indicates if the campaign has been locked, preventing updates, deletion, rescheduling or launching.
percentComplete Number Number representing the percent of users that have completed the campaign. Possible values are 1-100.
percentCorrect Number Number representing the percent of users that correctly answered questions within the campaign. Possible values are 1-100.
numCorrectAnswers Answer Count Object Timestamp indicating when the campaign was set to be launched, in ISO 8601 format.
Title Object
Field Type Description
id String The Mimecast secure ID of the campaign title.
title String The title name.
titleForCustomerModule Boolean Indicates if the title information is for a custom module.
correctAnswers Answer Count Object An object providing the counts of correct responses to each question.
defaultGifs GIFs Object An object containing links to the correct and incorrect answer images.
Answer Count Object
Field Type Description
forQuestion1 Number Count for the number of users that correctly answered question number one.
forQuestion2 Number Count for the number of users that correctly answered question number two.
forQuestion3 Number Count for the number of users that correctly answered question number 3.
GIFs Object
Field Type Description
correctGif String URL to the image displayed when a user answers the question correctly.
incorrectGif String URL to the image displayed when a user answers the question incorrectly.
Group Object
Field Type Description
folders Array of Group Objects Child groups of the current group level.
userCount Number Count of users in the current group.
description String Name of the current group.
id String The Mimecast secure ID of the current group.
source String Creation source of the current group. Possible values are cloud or ldap.
folderCount Number Count of the number of child-groups.
parentId String The Mimecast secure ID of the parent level group.
Email Message Object
Field Type Description
body String Contents of the message body sent to users.
subject String Contents of the message subject sent to users.
Campaigns Statistics Object
Field Type Description
numCorrectAnswers Number Count showing the number of correct answers across all other campaigns.
numCampaigns Number Count showing the number of other campaigns.
numSent Number Count showing the number of other campaigns sent to users.
numCompleted Number Count showing the number of all campaigns completed.

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/campaign/get-campaigns
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":[]
}
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/campaign/get-campaigns"
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': []
    }

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/campaign/get-campaigns";
            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"": []
                }";

            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/campaign/get-campaigns"
$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"": []
                }"

#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/campaign/get-campaigns";
        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" +
        "}";
        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());
    }