Get Phishing Campaign

Description

This API endpoint can be used to get all campaign-level information on Awareness Training Mime|OS Phishing Campaigns created, both pending and launched. (Data displayed on Phishing > 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 endpoint you send a POST request to:

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

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": [
{
"id": "String"
}
]
}
data
Field Type Required Description
id String Optional The Mimecast secure ID of an existing phishing campaign. If no ID is provided, all campaigns will be returned.

Response

{
"fail": [],
"meta": {
"status": 200
},
"data": [
{
"templates": [
{
"displayTitle": "Sting",
"id": "Sting"
}
],
"locale": "Sting",
"locked": false,
"timeSlotSelected": "Sting",
"id": "Sting",
"sender": {
"name": "String",
"email": "String"
},
"group": {
"description": "Sting",
"source": "Sting",
"folderCount": 0,
"parentId": "Sting",
"id": "Sting",
"userCount": 5
},
"name": "Sting",
"numSent": 1,
"launchDate": "Date Sting",
"numClicked": 1,
"numOpened": 4,
"numSubmitted": 5
}
]
}
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
id String The Mimecast secure ID of the phishing campaign.
name String Name of the phishing campaign.
templates Array of Phishing Campaign Templates The templates used in the phishing campaign.
sender Sender Object Information about the sender address specified for the phishing campaign.
group Group Object Information about the group that was select when creating the phishing campaign.
launchDate Date String Timestamp of the phishing campaign launch in ISO 8601 format.
locale String Template language used by the phishing campaign in ISO 3166-1 alpha-2 format (e.g. n, es, zh, fr, de, ja, it, ru, pt, nl, hi, ko, cs, pl, ar, tr).
timeSlotSelected String Window in which the campaign was configured to be sent, by GMT Timezone. Possible values are TZ1, TZ2, TZ3 or TZ4.
numSubmitted Number Count of users that have submitted a response to the phishing message.
numOpened Number Count of users that have opened the phishing message.
numClicked Number Count of users that clicked the phishing link within the message.
numSent Number Count of the users that have been sent the phishing message.
Phishing Campaign Template Object
Field Type Description
displayTitle String Title of the phishing template.
id String The Mimecast secure ID of the phishing template.
Sender Object
Field Type Description
name String Display name of the phishing message sender.
email String Email address of the phishing message sneder.
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.

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":[
{
"id": "String"
}
]
}
Back to Top