# Phishguard

# Reports

## Get PhishGuard reports

`client.emailSecurity.phishguard.reports.list(ReportListParamsparams, RequestOptionsoptions?): SinglePage<ReportListResponse>`

**get** `/accounts/{account_id}/email-security/phishguard/reports`

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

- `params: ReportListParams`

  - `account_id: string`

    Path param: Identifier.

  - `end?: string`

    Query param: End of the time range (RFC3339). Takes precedence over to_date.

  - `from_date?: string`

    Query param: Deprecated, use `start` instead. Start date in YYYY-MM-DD format.

  - `start?: string`

    Query param: Start of the time range (RFC3339). Takes precedence over from_date.

  - `to_date?: string`

    Query param: Deprecated, use `end` instead. End date in YYYY-MM-DD format.

### Returns

- `ReportListResponse`

  - `id: number`

  - `content: string`

  - `disposition: "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more`

    - `"MALICIOUS"`

    - `"MALICIOUS-BEC"`

    - `"SUSPICIOUS"`

    - `"SPOOF"`

    - `"SPAM"`

    - `"BULK"`

    - `"ENCRYPTED"`

    - `"EXTERNAL"`

    - `"UNKNOWN"`

    - `"NONE"`

  - `fields: Fields`

    - `to: Array<string>`

    - `from?: string | null`

    - `occurred_at?: string`

    - `postfix_id?: string | null`

    - `ts?: string`

      Deprecated, use `occurred_at` instead

  - `priority: string`

  - `title: string`

  - `created_at?: string | null`

  - `tags?: Array<Tag> | null`

    - `category: string`

    - `value: string`

  - `ts?: string`

    Deprecated, use `created_at` instead

  - `updated_at?: string | null`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const reportListResponse of client.emailSecurity.phishguard.reports.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(reportListResponse.id);
}
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": 0,
      "content": "content",
      "disposition": "MALICIOUS",
      "fields": {
        "to": [
          "string"
        ],
        "from": "from",
        "occurred_at": "2019-12-27T18:11:19.117Z",
        "postfix_id": "postfix_id",
        "ts": "2019-12-27T18:11:19.117Z"
      },
      "priority": "priority",
      "title": "title",
      "created_at": "2019-12-27T18:11:19.117Z",
      "tags": [
        {
          "category": "category",
          "value": "value"
        }
      ],
      "ts": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "success": true
}
```

## Domain Types

### Report List Response

- `ReportListResponse`

  - `id: number`

  - `content: string`

  - `disposition: "MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more`

    - `"MALICIOUS"`

    - `"MALICIOUS-BEC"`

    - `"SUSPICIOUS"`

    - `"SPOOF"`

    - `"SPAM"`

    - `"BULK"`

    - `"ENCRYPTED"`

    - `"EXTERNAL"`

    - `"UNKNOWN"`

    - `"NONE"`

  - `fields: Fields`

    - `to: Array<string>`

    - `from?: string | null`

    - `occurred_at?: string`

    - `postfix_id?: string | null`

    - `ts?: string`

      Deprecated, use `occurred_at` instead

  - `priority: string`

  - `title: string`

  - `created_at?: string | null`

  - `tags?: Array<Tag> | null`

    - `category: string`

    - `value: string`

  - `ts?: string`

    Deprecated, use `created_at` instead

  - `updated_at?: string | null`