reports
Creates, updates, deletes, gets or lists a reports resource.
Overview
| Name | reports |
| Type | Resource |
| Id | cloudflare.email_security.reports |
Fields
The following fields are returned by SELECT queries:
- list
List of PhishGuard reports
| Name | Datatype | Description |
|---|---|---|
id | integer | |
content | string | |
created_at | string (date-time) | |
disposition | string | (MALICIOUS, MALICIOUS-BEC, SUSPICIOUS, SPOOF, SPAM, BULK, ENCRYPTED, EXTERNAL, UNKNOWN, NONE) |
fields | object | |
priority | string | |
tags | array | |
title | string | |
ts | string (date-time) | Deprecated, use created_at instead |
updated_at | string (date-time) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | account_id | start, end, from_date, to_date | Retrieves PhishGuard security alert reports for a specified date range. Reports include detected threats, dispositions, and contextual information. Use for security monitoring and threat analysis. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
end | string (date-time) | End of the time range (RFC3339). Takes precedence over to_date. |
from_date | string (date) | Deprecated, use start instead. Start date in YYYY-MM-DD format. |
start | string (date-time) | Start of the time range (RFC3339). Takes precedence over from_date. |
to_date | string (date) | Deprecated, use end instead. End date in YYYY-MM-DD format. |
SELECT examples
- list
Retrieves PhishGuard security alert reports for a specified date range. Reports include detected threats, dispositions, and contextual information. Use for security monitoring and threat analysis.
SELECT
id,
content,
created_at,
disposition,
fields,
priority,
tags,
title,
ts,
updated_at
FROM cloudflare.email_security.reports
WHERE account_id = '{{ account_id }}' -- required
AND start = '{{ start }}'
AND end = '{{ end }}'
AND from_date = '{{ from_date }}'
AND to_date = '{{ to_date }}'
;