# Proofpoint

> Read Proofpoint Targeted Attack Protection: threat messages and malicious clicks, campaigns, forensics, Very Attacked People and top clickers, decode rewritten links, and start workflows when a threat is delivered or a malicious link is clicked.

App · 13 actions. Web page: https://docs.lodol.com/docs/integrations/proofpoint

## Actions

### Decode URLs

Get the original links behind links Proofpoint URL Defense rewrote (urldefense.proofpoint.com or urldefense.com), with the message and recipient each was rewritten for. Up to 100 at a time.

**Inputs**

- Links (`urls`, list, required): The rewritten links to decode.

**Outputs**

- `count` (number): How many links came back
- `decoded` (number): How many were decoded
- `urls` (list): Each link, in the order given

**Example output**

```json
{
  "count": 1,
  "decoded": 1,
  "urls": [
    {
      "clusterName": "example_hosted",
      "decodedUrl": "http://www.example.com/",
      "encodedUrl": "https://urldefense.proofpoint.com/v2/url?u=http-3A__www.example.com_&d=DwMFaQ&c=x&r=y&m=z&s=w&e=",
      "error": "",
      "messageGuid": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "recipientEmail": "clark.kent@example.com",
      "success": true
    }
  ]
}
```

### Get campaign

Get a threat campaign with its description, the actors behind it, its malware, techniques and imitated brands, and the threats in it.

**Inputs**

- Campaign (`campaign_id`, text, required): The campaign. Pick one active in the last day, or give its id from an event or 'List campaigns'.

**Outputs**

- `actors` (list): The threat actors behind it
- `brands` (list): The brands it imitates
- `campaignMembers` (list): The threats in it
- `description` (text): Proofpoint's description of the campaign
- `families` (list): Its threat families
- `id` (text): The campaign's id
- `malware` (list): The malware it delivers
- `name` (text): The campaign's name
- `notable` (true/false): True if marked notable
- `startDate` (text): When the campaign started
- `techniques` (list): The techniques it uses

**Example output**

```json
{
  "actors": [
    {
      "id": "95d2068e-6c19-48c0-a036-3366f9a3ea8e",
      "name": "TA511"
    }
  ],
  "brands": [
    {
      "id": "bd0f6db2-1728-4e0b-ad8b-3135ca9616bc",
      "name": "DocuSign"
    }
  ],
  "campaignMembers": [
    {
      "id": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "subType": "DOMAIN",
      "threat": "badsite.example",
      "threatTime": "2026-11-12T09:59:30.000Z",
      "type": "url"
    }
  ],
  "description": "DocuSign themed messages that link to an Office file with macros.",
  "families": [
    {
      "id": "f5dfd745-370b-4ffb-9a12-3ebf040fd5c4",
      "name": "Stealer"
    }
  ],
  "id": "aa9b3d62-4d72-4ebc-8f39-3da3833e7038",
  "malware": [
    {
      "id": "a37f32e5-99f8-48af-9821-61e5dc4c71d3",
      "name": "Tordal"
    }
  ],
  "name": "Tordal \"2203_78291\" | US Targeting | URLs | 24 March 2026",
  "notable": false,
  "startDate": "2026-11-11T00:01:00.000Z",
  "techniques": [
    {
      "id": "951f1df0-c81b-41ef-ac31-dd90a421bffa",
      "name": "Office VBA Macro"
    }
  ]
}
```

### Get forensics

Get the evidence Proofpoint's sandbox found for a threat or a whole campaign: links, DNS lookups, network traffic, files and screenshots. Give a threat or a campaign.

**Inputs**

- Threat ID (`threat_id`, text): The threat's id, from a message's threatsInfoMap or a click's threatID. Leave empty to give a campaign instead.
- Campaign (`campaign_id`, text): A campaign, for the evidence of every threat in it. Leave empty when giving a threat.
- Whole campaign (`include_campaign_forensics`, true/false): With a threat: turn on for the evidence of its whole campaign, if it belongs to one.

**Outputs**

- `generated` (text): When the report was generated
- `reports` (list): The forensic reports

**Example output**

```json
{
  "generated": "2026-11-12T11:02:00.000Z",
  "reports": [
    {
      "forensics": [
        {
          "display": "URL http://badsite.example/login is malicious",
          "malicious": true,
          "platforms": [
            {
              "name": "windows 7 sp1",
              "os": "windows 7",
              "version": "4.5.661"
            }
          ],
          "time": 0,
          "type": "url",
          "what": {
            "blacklisted": true,
            "url": "http://badsite.example/login"
          }
        }
      ],
      "id": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "name": "http://badsite.example/login",
      "scope": "THREAT",
      "type": "url"
    }
  ]
}
```

### Get threat

Get a threat's summary: its type and category, status, severity, how many other Proofpoint customers received it, and the actors, malware and brands involved.

**Inputs**

- Threat ID (`threat_id`, text, required): The threat's id: a message's threatsInfoMap threatId, a click's threatID, or the end of the threat's address in the TAP Dashboard.

**Outputs**

- `actors` (list): The threat actors behind it
- `attackSpread` (number): How many other Proofpoint customers received it
- `brands` (list): The brands it imitates
- `category` (text): impostor, malware, phish or spam
- `detectionType` (text): How it was detected
- `families` (list): Its threat families
- `geographies` (true/false): True if it targets a region
- `id` (text): The threat's id
- `identifiedAt` (text): When Proofpoint identified it
- `malware` (list): The malware involved
- `name` (text): The threat's name
- `notable` (true/false): True if marked notable
- `severity` (number): Severity score, 0 to 1000
- `status` (text): active or cleared
- `techniques` (list): The techniques it uses
- `type` (text): attachment, url or messageText
- `verticals` (true/false): True if it targets an industry

**Example output**

```json
{
  "actors": [
    {
      "id": "95d2068e-6c19-48c0-a036-3366f9a3ea8e",
      "name": "TA511"
    }
  ],
  "attackSpread": 62,
  "brands": [
    {
      "id": "bd0f6db2-1728-4e0b-ad8b-3135ca9616bc",
      "name": "DocuSign"
    }
  ],
  "category": "phish",
  "detectionType": "URL",
  "families": [
    {
      "id": "f5dfd745-370b-4ffb-9a12-3ebf040fd5c4",
      "name": "Credential phishing"
    }
  ],
  "geographies": false,
  "id": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
  "identifiedAt": "2026-11-12T09:59:30.000Z",
  "malware": [],
  "name": "badsite.example/login",
  "notable": false,
  "severity": 20,
  "status": "active",
  "techniques": [],
  "type": "url",
  "verticals": false
}
```

### List all threat events

List every message with a threat, delivered or blocked, and every click on a malicious link, permitted or blocked, in a window. Reads up to an hour, in the last seven days; leave Start and End empty for the last hour.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last hour, or to read the hour before End.
- End (`end_time`, date and time): The end of the window, at most hour after Start. Leave empty for hour after Start (or now, if that's sooner).
- Threat type (`threat_type`, text): Only events with this kind of threat. Leave empty for all. One of: `url` (Malicious links), `attachment` (Malicious attachments), `messageText` (Message text (such as impostor email)).
- Threat status (`threat_status`, text): Only events whose threat has this status. Leave empty for active and cleared threats. One of: `active`, `cleared`, `falsePositive` (False positive).

**Outputs**

- `clicksBlocked` (list): Clicks on malicious links that were blocked
- `clicksPermitted` (list): Clicks on malicious links that went through
- `count` (number): How many events came back
- `interval` (text): The window read, as start/end in UTC
- `messagesBlocked` (list): Messages with a threat that Proofpoint blocked
- `messagesDelivered` (list): Messages with a threat that reached the inbox
- `queryEndTime` (text): The end of the window Proofpoint read

**Example output**

```json
{
  "clicksBlocked": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
      "classification": "phish",
      "clickIP": "192.0.2.1",
      "clickTime": "2026-11-12T10:05:20.000Z",
      "id": "b6d0a9cc-0000-4000-8000-000000000003",
      "messageID": "20261112.1234@evil.example",
      "recipient": "clark.kent@example.com",
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "threatID": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "threatStatus": "active",
      "threatTime": "2026-11-12T09:59:30.000Z",
      "threatURL": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8",
      "url": "http://badsite.example/login",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
    }
  ],
  "clicksPermitted": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
      "classification": "phish",
      "clickIP": "192.0.2.1",
      "clickTime": "2026-11-12T10:05:20.000Z",
      "id": "a5c9f8bb-4be8-4c5f-9b4f-0d6a1e8f7c21",
      "messageID": "20261112.1234@evil.example",
      "recipient": "clark.kent@example.com",
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "threatID": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "threatStatus": "active",
      "threatTime": "2026-11-12T09:59:30.000Z",
      "threatURL": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8",
      "url": "http://badsite.example/login",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
    }
  ],
  "count": 4,
  "interval": "2026-11-12T10:00:00Z/2026-11-12T11:00:00Z",
  "messagesBlocked": [
    {
      "GUID": "a1b2c3d4-0000-4000-8000-000000000002",
      "QID": "r2FNwRHF004109",
      "ccAddresses": [],
      "clusterId": "example_hosted",
      "completelyRewritten": "true",
      "fromAddress": [
        "badguy@evil.example"
      ],
      "headerFrom": "\"A. Badguy\" <badguy@evil.example>",
      "headerReplyTo": null,
      "impostorScore": 0,
      "malwareScore": 0,
      "messageID": "20261112.1234@evil.example",
      "messageParts": [
        {
          "contentType": "text/html",
          "disposition": "inline",
          "filename": "text.html",
          "md5": "6a1e1f1a7a0d1b3c5e2f4a6b8c0d2e4f",
          "oContentType": "text/html",
          "sandboxStatus": null,
          "sha256": "1b2a3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809"
        }
      ],
      "messageSize": 2793,
      "messageTime": "2026-11-12T10:00:09.000Z",
      "modulesRun": [
        "pdr",
        "sandbox",
        "spam",
        "urldefense"
      ],
      "phishScore": 46,
      "policyRoutes": [
        "default_inbound"
      ],
      "quarantineFolder": "Phish",
      "quarantineRule": "module.urldefense.phish",
      "recipient": [
        "clark.kent@example.com"
      ],
      "replyToAddress": [],
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "spamScore": 4,
      "subject": "Please find a totally safe invoice attached.",
      "threatsInfoMap": [
        {
          "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
          "classification": "phish",
          "detectionType": "URL",
          "threat": "badsite.example",
          "threatId": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
          "threatStatus": "active",
          "threatTime": "2026-11-12T09:59:30.000Z",
          "threatType": "url",
          "threatUrl": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8"
        }
      ],
      "toAddresses": [
        "clark.kent@example.com"
      ],
      "xmailer": null
    }
  ],
  "messagesDelivered": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "QID": "r2FNwRHF004109",
      "ccAddresses": [],
      "clusterId": "example_hosted",
      "completelyRewritten": "true",
      "fromAddress": [
        "badguy@evil.example"
      ],
      "headerFrom": "\"A. Badguy\" <badguy@evil.example>",
      "headerReplyTo": null,
      "impostorScore": 0,
      "malwareScore": 0,
      "messageID": "20261112.1234@evil.example",
      "messageParts": [
        {
          "contentType": "text/html",
          "disposition": "inline",
          "filename": "text.html",
          "md5": "6a1e1f1a7a0d1b3c5e2f4a6b8c0d2e4f",
          "oContentType": "text/html",
          "sandboxStatus": null,
          "sha256": "1b2a3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809"
        }
      ],
      "messageSize": 2793,
      "messageTime": "2026-11-12T10:00:09.000Z",
      "modulesRun": [
        "pdr",
        "sandbox",
        "spam",
        "urldefense"
      ],
      "phishScore": 46,
      "policyRoutes": [
        "default_inbound"
      ],
      "quarantineFolder": null,
      "quarantineRule": null,
      "recipient": [
        "clark.kent@example.com"
      ],
      "replyToAddress": [],
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "spamScore": 4,
      "subject": "Please find a totally safe invoice attached.",
      "threatsInfoMap": [
        {
          "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
          "classification": "phish",
          "detectionType": "URL",
          "threat": "badsite.example",
          "threatId": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
          "threatStatus": "active",
          "threatTime": "2026-11-12T09:59:30.000Z",
          "threatType": "url",
          "threatUrl": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8"
        }
      ],
      "toAddresses": [
        "clark.kent@example.com"
      ],
      "xmailer": null
    }
  ],
  "queryEndTime": "2026-11-12T11:00:00Z"
}
```

### List blocked clicks

List clicks on malicious links that Proofpoint blocked, with who clicked, when and from where, in a window. Reads up to an hour, in the last seven days; leave Start and End empty for the last hour.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last hour, or to read the hour before End.
- End (`end_time`, date and time): The end of the window, at most hour after Start. Leave empty for hour after Start (or now, if that's sooner).
- Threat type (`threat_type`, text): Only events with this kind of threat. Leave empty for all. One of: `url` (Malicious links), `attachment` (Malicious attachments), `messageText` (Message text (such as impostor email)).
- Threat status (`threat_status`, text): Only events whose threat has this status. Leave empty for active and cleared threats. One of: `active`, `cleared`, `falsePositive` (False positive).

**Outputs**

- `clicksBlocked` (list): Clicks on malicious links that were blocked
- `count` (number): How many events came back
- `interval` (text): The window read, as start/end in UTC
- `queryEndTime` (text): The end of the window Proofpoint read

**Example output**

```json
{
  "clicksBlocked": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
      "classification": "phish",
      "clickIP": "192.0.2.1",
      "clickTime": "2026-11-12T10:05:20.000Z",
      "id": "b6d0a9cc-0000-4000-8000-000000000003",
      "messageID": "20261112.1234@evil.example",
      "recipient": "clark.kent@example.com",
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "threatID": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "threatStatus": "active",
      "threatTime": "2026-11-12T09:59:30.000Z",
      "threatURL": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8",
      "url": "http://badsite.example/login",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
    }
  ],
  "count": 1,
  "interval": "2026-11-12T10:00:00Z/2026-11-12T11:00:00Z",
  "queryEndTime": "2026-11-12T11:00:00Z"
}
```

### List blocked threat messages

List messages with a known threat that Proofpoint blocked or quarantined, with the quarantine folder and rule, in a window. Reads up to an hour, in the last seven days; leave Start and End empty for the last hour.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last hour, or to read the hour before End.
- End (`end_time`, date and time): The end of the window, at most hour after Start. Leave empty for hour after Start (or now, if that's sooner).
- Threat type (`threat_type`, text): Only events with this kind of threat. Leave empty for all. One of: `url` (Malicious links), `attachment` (Malicious attachments), `messageText` (Message text (such as impostor email)).
- Threat status (`threat_status`, text): Only events whose threat has this status. Leave empty for active and cleared threats. One of: `active`, `cleared`, `falsePositive` (False positive).

**Outputs**

- `count` (number): How many events came back
- `interval` (text): The window read, as start/end in UTC
- `messagesBlocked` (list): Messages with a threat that Proofpoint blocked
- `queryEndTime` (text): The end of the window Proofpoint read

**Example output**

```json
{
  "count": 1,
  "interval": "2026-11-12T10:00:00Z/2026-11-12T11:00:00Z",
  "messagesBlocked": [
    {
      "GUID": "a1b2c3d4-0000-4000-8000-000000000002",
      "QID": "r2FNwRHF004109",
      "ccAddresses": [],
      "clusterId": "example_hosted",
      "completelyRewritten": "true",
      "fromAddress": [
        "badguy@evil.example"
      ],
      "headerFrom": "\"A. Badguy\" <badguy@evil.example>",
      "headerReplyTo": null,
      "impostorScore": 0,
      "malwareScore": 0,
      "messageID": "20261112.1234@evil.example",
      "messageParts": [
        {
          "contentType": "text/html",
          "disposition": "inline",
          "filename": "text.html",
          "md5": "6a1e1f1a7a0d1b3c5e2f4a6b8c0d2e4f",
          "oContentType": "text/html",
          "sandboxStatus": null,
          "sha256": "1b2a3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809"
        }
      ],
      "messageSize": 2793,
      "messageTime": "2026-11-12T10:00:09.000Z",
      "modulesRun": [
        "pdr",
        "sandbox",
        "spam",
        "urldefense"
      ],
      "phishScore": 46,
      "policyRoutes": [
        "default_inbound"
      ],
      "quarantineFolder": "Phish",
      "quarantineRule": "module.urldefense.phish",
      "recipient": [
        "clark.kent@example.com"
      ],
      "replyToAddress": [],
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "spamScore": 4,
      "subject": "Please find a totally safe invoice attached.",
      "threatsInfoMap": [
        {
          "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
          "classification": "phish",
          "detectionType": "URL",
          "threat": "badsite.example",
          "threatId": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
          "threatStatus": "active",
          "threatTime": "2026-11-12T09:59:30.000Z",
          "threatType": "url",
          "threatUrl": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8"
        }
      ],
      "toAddresses": [
        "clark.kent@example.com"
      ],
      "xmailer": null
    }
  ],
  "queryEndTime": "2026-11-12T11:00:00Z"
}
```

### List campaigns

List the threat campaigns that were active against your organization in a window of up to a day (the last day if Start and End are empty). Proofpoint allows 50 of these a day.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last day, or to read the day before End.
- End (`end_time`, date and time): The end of the window, at most day after Start. Leave empty for day after Start (or now, if that's sooner).
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave. At least 1.
- Page size (`size`, number): How many to return, 1 to 200. Defaults to 100. From 1 to 200.

**Outputs**

- `campaigns` (list): The campaigns, by id
- `count` (number): How many came back on this page
- `interval` (text): The window read
- `next_page` (number): The page to ask for next, or 0 when there are no more
- `page` (number): The page read, from 1

**Example output**

```json
{
  "campaigns": [
    {
      "id": "aa9b3d62-4d72-4ebc-8f39-3da3833e7038",
      "lastUpdatedAt": "2026-11-12T10:37:46.000Z",
      "notable": false,
      "verticallyTargeted": false
    }
  ],
  "count": 1,
  "interval": "2026-11-11T11:00:00Z/2026-11-12T11:00:00Z",
  "next_page": 0,
  "page": 1
}
```

### List delivered threat messages

List messages with a known threat that were delivered to inboxes, with their sender, recipients, scores and threats, in a window. Reads up to an hour, in the last seven days; leave Start and End empty for the last hour.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last hour, or to read the hour before End.
- End (`end_time`, date and time): The end of the window, at most hour after Start. Leave empty for hour after Start (or now, if that's sooner).
- Threat type (`threat_type`, text): Only events with this kind of threat. Leave empty for all. One of: `url` (Malicious links), `attachment` (Malicious attachments), `messageText` (Message text (such as impostor email)).
- Threat status (`threat_status`, text): Only events whose threat has this status. Leave empty for active and cleared threats. One of: `active`, `cleared`, `falsePositive` (False positive).

**Outputs**

- `count` (number): How many events came back
- `interval` (text): The window read, as start/end in UTC
- `messagesDelivered` (list): Messages with a threat that reached the inbox
- `queryEndTime` (text): The end of the window Proofpoint read

**Example output**

```json
{
  "count": 1,
  "interval": "2026-11-12T10:00:00Z/2026-11-12T11:00:00Z",
  "messagesDelivered": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "QID": "r2FNwRHF004109",
      "ccAddresses": [],
      "clusterId": "example_hosted",
      "completelyRewritten": "true",
      "fromAddress": [
        "badguy@evil.example"
      ],
      "headerFrom": "\"A. Badguy\" <badguy@evil.example>",
      "headerReplyTo": null,
      "impostorScore": 0,
      "malwareScore": 0,
      "messageID": "20261112.1234@evil.example",
      "messageParts": [
        {
          "contentType": "text/html",
          "disposition": "inline",
          "filename": "text.html",
          "md5": "6a1e1f1a7a0d1b3c5e2f4a6b8c0d2e4f",
          "oContentType": "text/html",
          "sandboxStatus": null,
          "sha256": "1b2a3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809"
        }
      ],
      "messageSize": 2793,
      "messageTime": "2026-11-12T10:00:09.000Z",
      "modulesRun": [
        "pdr",
        "sandbox",
        "spam",
        "urldefense"
      ],
      "phishScore": 46,
      "policyRoutes": [
        "default_inbound"
      ],
      "quarantineFolder": null,
      "quarantineRule": null,
      "recipient": [
        "clark.kent@example.com"
      ],
      "replyToAddress": [],
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "spamScore": 4,
      "subject": "Please find a totally safe invoice attached.",
      "threatsInfoMap": [
        {
          "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
          "classification": "phish",
          "detectionType": "URL",
          "threat": "badsite.example",
          "threatId": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
          "threatStatus": "active",
          "threatTime": "2026-11-12T09:59:30.000Z",
          "threatType": "url",
          "threatUrl": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8"
        }
      ],
      "toAddresses": [
        "clark.kent@example.com"
      ],
      "xmailer": null
    }
  ],
  "queryEndTime": "2026-11-12T11:00:00Z"
}
```

### List issues

List what got through: messages with a threat that were delivered and clicks on malicious links that were permitted, in a window. Reads up to an hour, in the last seven days; leave Start and End empty for the last hour.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last hour, or to read the hour before End.
- End (`end_time`, date and time): The end of the window, at most hour after Start. Leave empty for hour after Start (or now, if that's sooner).
- Threat type (`threat_type`, text): Only events with this kind of threat. Leave empty for all. One of: `url` (Malicious links), `attachment` (Malicious attachments), `messageText` (Message text (such as impostor email)).
- Threat status (`threat_status`, text): Only events whose threat has this status. Leave empty for active and cleared threats. One of: `active`, `cleared`, `falsePositive` (False positive).

**Outputs**

- `clicksPermitted` (list): Clicks on malicious links that went through
- `count` (number): How many events came back
- `interval` (text): The window read, as start/end in UTC
- `messagesDelivered` (list): Messages with a threat that reached the inbox
- `queryEndTime` (text): The end of the window Proofpoint read

**Example output**

```json
{
  "clicksPermitted": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
      "classification": "phish",
      "clickIP": "192.0.2.1",
      "clickTime": "2026-11-12T10:05:20.000Z",
      "id": "a5c9f8bb-4be8-4c5f-9b4f-0d6a1e8f7c21",
      "messageID": "20261112.1234@evil.example",
      "recipient": "clark.kent@example.com",
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "threatID": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "threatStatus": "active",
      "threatTime": "2026-11-12T09:59:30.000Z",
      "threatURL": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8",
      "url": "http://badsite.example/login",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
    }
  ],
  "count": 2,
  "interval": "2026-11-12T10:00:00Z/2026-11-12T11:00:00Z",
  "messagesDelivered": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "QID": "r2FNwRHF004109",
      "ccAddresses": [],
      "clusterId": "example_hosted",
      "completelyRewritten": "true",
      "fromAddress": [
        "badguy@evil.example"
      ],
      "headerFrom": "\"A. Badguy\" <badguy@evil.example>",
      "headerReplyTo": null,
      "impostorScore": 0,
      "malwareScore": 0,
      "messageID": "20261112.1234@evil.example",
      "messageParts": [
        {
          "contentType": "text/html",
          "disposition": "inline",
          "filename": "text.html",
          "md5": "6a1e1f1a7a0d1b3c5e2f4a6b8c0d2e4f",
          "oContentType": "text/html",
          "sandboxStatus": null,
          "sha256": "1b2a3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f809"
        }
      ],
      "messageSize": 2793,
      "messageTime": "2026-11-12T10:00:09.000Z",
      "modulesRun": [
        "pdr",
        "sandbox",
        "spam",
        "urldefense"
      ],
      "phishScore": 46,
      "policyRoutes": [
        "default_inbound"
      ],
      "quarantineFolder": null,
      "quarantineRule": null,
      "recipient": [
        "clark.kent@example.com"
      ],
      "replyToAddress": [],
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "spamScore": 4,
      "subject": "Please find a totally safe invoice attached.",
      "threatsInfoMap": [
        {
          "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
          "classification": "phish",
          "detectionType": "URL",
          "threat": "badsite.example",
          "threatId": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
          "threatStatus": "active",
          "threatTime": "2026-11-12T09:59:30.000Z",
          "threatType": "url",
          "threatUrl": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8"
        }
      ],
      "toAddresses": [
        "clark.kent@example.com"
      ],
      "xmailer": null
    }
  ],
  "queryEndTime": "2026-11-12T11:00:00Z"
}
```

### List permitted clicks

List clicks on malicious links that Proofpoint let through, with who clicked, when and from where, in a window. Reads up to an hour, in the last seven days; leave Start and End empty for the last hour.

**Inputs**

- Start (`start_time`, date and time): The start of the window to read. Leave empty to read the last hour, or to read the hour before End.
- End (`end_time`, date and time): The end of the window, at most hour after Start. Leave empty for hour after Start (or now, if that's sooner).
- Threat type (`threat_type`, text): Only events with this kind of threat. Leave empty for all. One of: `url` (Malicious links), `attachment` (Malicious attachments), `messageText` (Message text (such as impostor email)).
- Threat status (`threat_status`, text): Only events whose threat has this status. Leave empty for active and cleared threats. One of: `active`, `cleared`, `falsePositive` (False positive).

**Outputs**

- `clicksPermitted` (list): Clicks on malicious links that went through
- `count` (number): How many events came back
- `interval` (text): The window read, as start/end in UTC
- `queryEndTime` (text): The end of the window Proofpoint read

**Example output**

```json
{
  "clicksPermitted": [
    {
      "GUID": "c26dbea0-80d5-463b-b93c-4e8b708219ce",
      "campaignId": "46e01b8a-c899-404d-bcd9-189bb393d1a7",
      "classification": "phish",
      "clickIP": "192.0.2.1",
      "clickTime": "2026-11-12T10:05:20.000Z",
      "id": "a5c9f8bb-4be8-4c5f-9b4f-0d6a1e8f7c21",
      "messageID": "20261112.1234@evil.example",
      "recipient": "clark.kent@example.com",
      "sender": "e99d7ed5580193f36a51f597bc2c0210@evil.example",
      "senderIP": "192.0.2.255",
      "threatID": "3ba97fc852c66a7ba761450edfdfb9f4ffab74715b591294f78b5e37a76481aa",
      "threatStatus": "active",
      "threatTime": "2026-11-12T09:59:30.000Z",
      "threatURL": "https://threatinsight.proofpoint.com/#/threat/email/3ba97fc8",
      "url": "http://badsite.example/login",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
    }
  ],
  "count": 1,
  "interval": "2026-11-12T10:00:00Z/2026-11-12T11:00:00Z",
  "queryEndTime": "2026-11-12T11:00:00Z"
}
```

### List top clickers

List the people who clicked malicious links most often, whether or not the clicks were blocked, with their click counts. Proofpoint allows 50 of these a day.

**Inputs**

- Period (`window`, text): How many days back the report covers. Defaults to 30 days. One of: `14` (Last 14 days), `30` (Last 30 days), `90` (Last 90 days). Default: `30`.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave. At least 1.
- Page size (`size`, number): How many to return, 1 to 200. Defaults to 100. From 1 to 200.

**Outputs**

- `count` (number): How many came back on this page
- `interval` (text): The period covered, as start/end
- `next_page` (number): The page to ask for next, or 0 when there are no more
- `page` (number): The page read, from 1
- `totalTopClickers` (number): How many top clickers there are
- `users` (list): The people, most clicks first

**Example output**

```json
{
  "count": 1,
  "interval": "2026-10-13T11:00:00Z/2026-11-12T11:00:00Z",
  "next_page": 0,
  "page": 1,
  "totalTopClickers": 1,
  "users": [
    {
      "clickStatistics": {
        "clickCount": 2,
        "families": [
          {
            "clicks": 2,
            "name": "Malware"
          }
        ]
      },
      "identity": {
        "customerUserId": null,
        "department": "Finance",
        "emails": [
          "clark.kent@example.com"
        ],
        "guid": "88e36bf359-99e8-7e53-f58a-6df8b430be6d",
        "location": "Metropolis",
        "name": "Clark Kent",
        "title": "Accountant",
        "vip": true
      }
    }
  ]
}
```

### List Very Attacked People

List your Very Attacked People: the people targeted most, with their attack index and the threat families aimed at them. Proofpoint allows 50 of these a day.

**Inputs**

- Period (`window`, text): How many days back the report covers. Defaults to 30 days. One of: `14` (Last 14 days), `30` (Last 30 days), `90` (Last 90 days). Default: `30`.
- Page (`page`, number): Which page to get, from 1. Use the 'next_page' an earlier run gave. At least 1.
- Page size (`size`, number): How many to return, 1 to 1,000. Defaults to 1,000. From 1 to 1000.

**Outputs**

- `averageAttackIndex` (number): The organization's average attack index
- `count` (number): How many came back on this page
- `interval` (text): The period covered, as start/end
- `next_page` (number): The page to ask for next, or 0 when there are no more
- `page` (number): The page read, from 1
- `totalVapUsers` (number): How many Very Attacked People there are
- `users` (list): The people, most attacked first
- `vapAttackIndexThreshold` (number): The attack index that makes someone a VAP

**Example output**

```json
{
  "averageAttackIndex": 604,
  "count": 1,
  "interval": "2026-10-13T11:00:00Z/2026-11-12T11:00:00Z",
  "next_page": 0,
  "page": 1,
  "totalVapUsers": 1,
  "users": [
    {
      "identity": {
        "customerUserId": null,
        "department": "Finance",
        "emails": [
          "clark.kent@example.com"
        ],
        "guid": "88e36bf359-99e8-7e53-f58a-6df8b430be6d",
        "location": "Metropolis",
        "name": "Clark Kent",
        "title": "Accountant",
        "vip": true
      },
      "threatStatistics": {
        "attackIndex": 1805,
        "families": [
          {
            "name": "credential phishing",
            "score": 700
          }
        ]
      }
    }
  ],
  "vapAttackIndexThreshold": 1032
}
```
