POST /filteringlog/getReport

The /filteringlog/getReport endpoint allows you to retrieve the list of filtering log events for inbound or outbound SMTP traffic.

Request

curl -X POST \
  'https://cloud.vadesecure.com/rest/v3.0/filteringlog/getReport' \
  -H 'x-vrc-authorization: "LOGIN:TOKEN"' \
  -H 'Content-type: application/json' \
  --data '{
    "userId": your_accountID,
    "pageSize": 10,
    "pageToGet": 0,
    "streamType": "Inbound",
    "period":"DAYS_07",
    "sortOrder":1,
    "sortFieldName": "date",
    "startDate":"1614836482000"
  }'; echo

x-vrc-authorization - Required

string

The authorization token that must be passed to the request for authorization.

The header value is the concatenation of:

authHeader = LOGIN:TOKEN

LOGIN corresponds to the login that was provided when retrieving the authorization token.
TOKEN corresponds to the content of the x-vrc-authorization header that was returned when retrieving the authorization token.

Accept

application/json

userId - Required

integer

Defines the unique Account ID the request should be applied to. This corresponds to the Account ID that was retrieved following the steps described in Retrieve Auth token and accountID.

pageSize - Required

integer

The number of items you want to display on one page.

Note: "pageSize: 10" displays 10 items.

pageToGet - Required

integer

The number of the page you want to display. The number of pages available is returned in the response via availablePages.

Note: "pageSize: 20, pageToGet: 2" displays the items from 40 to 60.

streamType

string

The traffic flow the messages were in. One of inbound or outbound.

period

string

The time range to apply the search to, based on the startDate parameter. One of MINUTES_01, MINUTES_05, MINUTES_15, MINUTES_30, HOURS_01, HOURS_02, HOURS_04, HOURS_08, HOURS_12, DAYS_01, DAYS_07, DAYS_14, DAYS_30, DAYS_90.

streamType

string

The traffic flow the messages were in. One of inbound or outbound.

period

string

startDate - Required

integer

The date the search should start on, provided as a milliseconds timestamp.

sortOrder

integer

Sorting logs on ascending order or descending order.

sortOrder: 0 = ASC

sortOrder: 1 = DESC

period - Required

string

The time range to apply the search to, based on the startDate parameter among: MINUTES_01, MINUTES_05, MINUTES_15, MINUTES_30, HOURS_01, HOURS_02, HOURS_04, HOURS_08, HOURS_12, DAYS_01, DAYS_07, DAYS_14, DAYS_30, DAYS_90.

messageType

string

The category of the message. One of legit, spam, bounce, virus, advertising, blacklisting, whitelisted, social.

operationType

string

The operation applied to the message. One of route, tag, quarantine, reject, admin_quarantine, sandboxing.

rejectType

string

The reason the message was rejected. One of dkim, size, mime, spf, rbl, greylisting.

sender

string

The email address of the sender.

recipient

string

The email address of the recipient.

Response

200 OK application/json

The response body contains a JSON blob which can be parsed to retrieve the Account ID.

400 Error application/json

In case an error occurred, a 400 error is returned along with a JSON object containing a description of the error, typically:

{"error": "error description"}

401 Unauthorized application/json

There was a problem authenticating your request.

logs

array

The logs array contains the list of events, provided as JSON objects. Each object provides details about each event.

domain: string; The recipient domain name.
date: integer; Date (provided as milliseconds timestamp) that the current event occurred.
filterReason: string; The reason (full text) the message was rejected.
filterType: string; The reason the message was rejected. One of dkim, size, mime, spf, rbl, greylisting.
from: string; The email address of the sender.
to: string; The email address of the recipient.
hostname: string; The hostname of the MTA server that received the message.
ip: string; The original IP address of the sender (SMTP Client).
message: string; The complete log message, in text format.
messageId: string; The unique message ID of the message. This message ID can be used to request more details about the processing of a specific message, and serves as input parameter for the POST /filteringlog/getDetail endpoint.
messageType: string; The message category: UNKNOWN, LEGITIMATE, SPAM, NOTIFICATION, VIRUS, ADVERTISING, BLACK, WHITE, SOCIAL, SPEAR_PHISHING.
operationType: string; The operation applied to the message. One of route, tag, quarantine, reject, admin_quarantine, sandboxing.
sandboxed: boolean; true in case the message was sandboxed for malware identification (deprecated).

site: string; The client login (starting with VRC...).
spamLevel: string; The spam level that was detected by the filter.
subject: string; The original subject of the message.
tag: string; The tag that was prepended to the message subject, if any.

availablePages

integer

The total number of pages available depending on the number of items to display defined using pageSize.

currentPage

integer

The current page number you are viewing.

analyzingPercent

integer

The percentage of completeness of the current analyzingPhase returned, for building the log report.

analyzingPhase

string

The current phase of the current report.

complete

boolean

Indicates true in case the report is complete.

limit

integer

The maximum number of log events returned in a report. Defaults to 10,000.

{
    "analyzingPercent": 100,
    "analyzingPhase": "Creating report",
    "availablePages": 50,
    "complete": true,
    "currentPage": 0,
    "limit": 10,
    "logs": [
        {
            "date": 1615440980000,
            "domain": "domain.fr",
            "filterReason": "nil",
            "filterType": "UNKNWON",
            "from": "sender@sdomain.fr",
            "hostname": "vcfr1mtai06p.internal.vadesecure.com",
            "ip": "1.2.3.4",
            "message": "2021-03-11T06:36:20+01:00 vcfr1mtai06p.internal.vadesecure.com ulog[21682]: [0049D9D1] \
                        qid=4DwyNh2Symz1y3J,ip=80.12.242.134,sender=sender@sdomain.fr, \
                        site=VRC1350570,domain=domain.fr,recipient=rcpt@domain.fr: \
                        action=tag,status=social,spamlevel=unknwon,tag=[SOCIAL],stop=nil,reply=nil, \
                        subject=\"\ud83c\udf82 It\u2019s Sophie\u2019s birthday today\"",
            "messageId": "4DwyNh2Symz1y3J",
            "messageType": "SOCIAL",
            "operationType": "TAG",
            "sandboxed": false,
            "site": "VRC1350570",
            "spamLevel": "UNKNWON",
            "subject": "\ud83c\udf82 It\u2019s Sophie\u2019s birthday today",
            "tag": "[SOCIAL]",
            "to": "rcpt@domain.fr"
        },
      ...
   ]
}