Proofpoint
App · 13 actions
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.
Actions
| Action | What it does |
|---|---|
| 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. |
| Get campaign | Get a threat campaign with its description, the actors behind it, its malware, techniques and imitated brands, and the threats in it. |
| Get forensics | Get the evidence Proofpoint's sandbox found for a threat or a whole campaign: links, DNS lookups, network traffic, files and screenshots. |
| 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. |
| 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. |
| List blocked clicks | List clicks on malicious links that Proofpoint blocked, with who clicked, when and from where, in a window. |
| List blocked threat messages | List messages with a known threat that Proofpoint blocked or quarantined, with the quarantine folder and rule, in a window. |
| 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). |
| 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. |
| List issues | List what got through: messages with a threat that were delivered and clicks on malicious links that were permitted, in a window. |
| List permitted clicks | List clicks on malicious links that Proofpoint let through, with who clicked, when and from where, in a window. |
| List top clickers | List the people who clicked malicious links most often, whether or not the clicks were blocked, with their click counts. |
| List Very Attacked People | List your Very Attacked People: the people targeted most, with their attack index and the threat families aimed at them. |
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
urlslistRequired - The rewritten links to decode.
Outputs
countnumber- How many links came back
decodednumber- How many were decoded
urlslist- Each link, in the order given
Example output
{
"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_idtextRequired - The campaign. Pick one active in the last day, or give its id from an event or 'List campaigns'.
Outputs
actorslist- The threat actors behind it
brandslist- The brands it imitates
campaignMemberslist- The threats in it
descriptiontext- Proofpoint's description of the campaign
familieslist- Its threat families
idtext- The campaign's id
malwarelist- The malware it delivers
nametext- The campaign's name
notabletrue/false- True if marked notable
startDatetext- When the campaign started
techniqueslist- The techniques it uses
Example output
{
"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_idtext - The threat's id, from a message's threatsInfoMap or a click's threatID. Leave empty to give a campaign instead.
- Campaign
campaign_idtext - A campaign, for the evidence of every threat in it. Leave empty when giving a threat.
- Whole campaign
include_campaign_forensicstrue/false - With a threat: turn on for the evidence of its whole campaign, if it belongs to one.
Outputs
generatedtext- When the report was generated
reportslist- The forensic reports
Example output
{
"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_idtextRequired - 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
actorslist- The threat actors behind it
attackSpreadnumber- How many other Proofpoint customers received it
brandslist- The brands it imitates
categorytext- impostor, malware, phish or spam
detectionTypetext- How it was detected
familieslist- Its threat families
geographiestrue/false- True if it targets a region
idtext- The threat's id
identifiedAttext- When Proofpoint identified it
malwarelist- The malware involved
nametext- The threat's name
notabletrue/false- True if marked notable
severitynumber- Severity score, 0 to 1000
statustext- active or cleared
techniqueslist- The techniques it uses
typetext- attachment, url or messageText
verticalstrue/false- True if it targets an industry
Example output
{
"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_timedate 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_timedate 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_typetext - 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_statustext - Only events whose threat has this status. Leave empty for active and cleared threats.One of:
active,cleared,falsePositive(False positive).
Outputs
clicksBlockedlist- Clicks on malicious links that were blocked
clicksPermittedlist- Clicks on malicious links that went through
countnumber- How many events came back
intervaltext- The window read, as start/end in UTC
messagesBlockedlist- Messages with a threat that Proofpoint blocked
messagesDeliveredlist- Messages with a threat that reached the inbox
queryEndTimetext- The end of the window Proofpoint read
Example output
{
"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_timedate 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_timedate 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_typetext - 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_statustext - Only events whose threat has this status. Leave empty for active and cleared threats.One of:
active,cleared,falsePositive(False positive).
Outputs
clicksBlockedlist- Clicks on malicious links that were blocked
countnumber- How many events came back
intervaltext- The window read, as start/end in UTC
queryEndTimetext- The end of the window Proofpoint read
Example output
{
"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_timedate 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_timedate 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_typetext - 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_statustext - Only events whose threat has this status. Leave empty for active and cleared threats.One of:
active,cleared,falsePositive(False positive).
Outputs
countnumber- How many events came back
intervaltext- The window read, as start/end in UTC
messagesBlockedlist- Messages with a threat that Proofpoint blocked
queryEndTimetext- The end of the window Proofpoint read
Example output
{
"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_timedate 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_timedate 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
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
sizenumber - How many to return, 1 to 200. Defaults to 100.From 1 to 200.
Outputs
campaignslist- The campaigns, by id
countnumber- How many came back on this page
intervaltext- The window read
next_pagenumber- The page to ask for next, or 0 when there are no more
pagenumber- The page read, from 1
Example output
{
"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_timedate 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_timedate 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_typetext - 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_statustext - Only events whose threat has this status. Leave empty for active and cleared threats.One of:
active,cleared,falsePositive(False positive).
Outputs
countnumber- How many events came back
intervaltext- The window read, as start/end in UTC
messagesDeliveredlist- Messages with a threat that reached the inbox
queryEndTimetext- The end of the window Proofpoint read
Example output
{
"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_timedate 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_timedate 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_typetext - 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_statustext - Only events whose threat has this status. Leave empty for active and cleared threats.One of:
active,cleared,falsePositive(False positive).
Outputs
clicksPermittedlist- Clicks on malicious links that went through
countnumber- How many events came back
intervaltext- The window read, as start/end in UTC
messagesDeliveredlist- Messages with a threat that reached the inbox
queryEndTimetext- The end of the window Proofpoint read
Example output
{
"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_timedate 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_timedate 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_typetext - 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_statustext - Only events whose threat has this status. Leave empty for active and cleared threats.One of:
active,cleared,falsePositive(False positive).
Outputs
clicksPermittedlist- Clicks on malicious links that went through
countnumber- How many events came back
intervaltext- The window read, as start/end in UTC
queryEndTimetext- The end of the window Proofpoint read
Example output
{
"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
windowtext - 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
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
sizenumber - How many to return, 1 to 200. Defaults to 100.From 1 to 200.
Outputs
countnumber- How many came back on this page
intervaltext- The period covered, as start/end
next_pagenumber- The page to ask for next, or 0 when there are no more
pagenumber- The page read, from 1
totalTopClickersnumber- How many top clickers there are
userslist- The people, most clicks first
Example output
{
"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
windowtext - 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
pagenumber - Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.
- Page size
sizenumber - How many to return, 1 to 1,000. Defaults to 1,000.From 1 to 1000.
Outputs
averageAttackIndexnumber- The organization's average attack index
countnumber- How many came back on this page
intervaltext- The period covered, as start/end
next_pagenumber- The page to ask for next, or 0 when there are no more
pagenumber- The page read, from 1
totalVapUsersnumber- How many Very Attacked People there are
userslist- The people, most attacked first
vapAttackIndexThresholdnumber- The attack index that makes someone a VAP
Example output
{
"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
}