In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Archive | View Logs | Read permission.
URI
To use this endpoint you send a POST request to:
/api/archive/get-view-logs
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": [
{
"query": "String",
"end": "Date String",
"start": "Date String"
}
]
}
meta
Field
Type
Required
Description
pagination
Object
Optional
An object defining paging options for the request.
Paginiation Object
Field
Type
Required
Description
pageSize
Number
Optional
The number of results to request.
pageToken
String
Optional
The value of the 'next' or 'previous' fields from an earlier request.
data
Field
Type
Required
Description
query
String
Optional
Query text that filters across the viewer, message from, message to, and subject fields.
start
Date String
Optional
The start date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000).
end
Date String
Optional
The end date in ISO 8601 date time format (e.g. 2011-12-03T10:15:30+0000).
Response
{
"fail": [],
"meta": {
"status": 200,
"pagination": {
"previous": "String",
"pageSize": 25,
"next": "String"
}
},
"data": [
{
"to": "String",
"from": "String",
"viewed": "2018-01-12T15:22:46+0000",
"source": "String",
"viewer": "String",
"messageDate": "2018-01-12T15:20:47+0000",
"discoveryCase": false,
"contentViewed": true,
"subject": "String"
}
]
}
meta object
Field
Type
Description
status
Number
The function level status of the request.
pagination
Object
An object containing paging information.
Pagination object
Field
Type
Description
pageSize
Number
The number of results requested.
next
String
A pageToken value that can be used to request the next page of results. Only returned if there are more results to return.
previous
String
A pageToken value that can be used to request the previous page of results. Only returned if there is a previous page.
data
Field
Type
Description
from
String
The sender of the viewed message.
to
String
The recipient of the viewed message.
viewer
String
The email address of the user who viewed the message.
source
String
The source of the message.
contentViewed
Boolean
If the message content was viewed or not.
discoveryCase
Boolean
If the viewed message is a part of an existing discovery case.
messageDate
Date String
The date tme that the message was received.
viewed
Date String
The date time that the message was viewed.
subject
String
The subject of the viewed message.
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/archive/get-view-logs
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}