Skip to main content

reports

Creates, updates, deletes, gets or lists a reports resource.

Overview

Namereports
TypeResource
Idcloudflare.email_security.reports

Fields

The following fields are returned by SELECT queries:

List of PhishGuard reports

NameDatatypeDescription
idinteger
contentstring
created_atstring (date-time)
dispositionstring (MALICIOUS, MALICIOUS-BEC, SUSPICIOUS, SPOOF, SPAM, BULK, ENCRYPTED, EXTERNAL, UNKNOWN, NONE)
fieldsobject
prioritystring
tagsarray
titlestring
tsstring (date-time)Deprecated, use created_at instead
updated_atstring (date-time)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_idstart, end, from_date, to_dateRetrieves 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.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
endstring (date-time)End of the time range (RFC3339). Takes precedence over to_date.
from_datestring (date)Deprecated, use start instead. Start date in YYYY-MM-DD format.
startstring (date-time)Start of the time range (RFC3339). Takes precedence over from_date.
to_datestring (date)Deprecated, use end instead. End date in YYYY-MM-DD format.

SELECT examples

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 }}'
;