# Phishguard

# Reports

## Get PhishGuard reports

`email_security.phishguard.reports.list(ReportListParams**kwargs)  -> SyncSinglePage[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

- `account_id: str`

  Identifier.

- `end: Optional[Union[str, datetime]]`

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

- `from_date: Optional[Union[null, null]]`

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

- `start: Optional[Union[str, datetime]]`

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

- `to_date: Optional[Union[null, null]]`

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

### Returns

- `class ReportListResponse: …`

  - `id: int`

  - `content: str`

  - `disposition: Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]`

    - `"MALICIOUS"`

    - `"MALICIOUS-BEC"`

    - `"SUSPICIOUS"`

    - `"SPOOF"`

    - `"SPAM"`

    - `"BULK"`

    - `"ENCRYPTED"`

    - `"EXTERNAL"`

    - `"UNKNOWN"`

    - `"NONE"`

  - `fields: Fields`

    - `to: List[str]`

    - `from_: Optional[str]`

    - `occurred_at: Optional[datetime]`

    - `postfix_id: Optional[str]`

    - `ts: Optional[datetime]`

      Deprecated, use `occurred_at` instead

  - `priority: str`

  - `title: str`

  - `created_at: Optional[datetime]`

  - `tags: Optional[List[Tag]]`

    - `category: str`

    - `value: str`

  - `ts: Optional[datetime]`

    Deprecated, use `created_at` instead

  - `updated_at: Optional[datetime]`

### Example

```python
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.email_security.phishguard.reports.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.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

- `class ReportListResponse: …`

  - `id: int`

  - `content: str`

  - `disposition: Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]`

    - `"MALICIOUS"`

    - `"MALICIOUS-BEC"`

    - `"SUSPICIOUS"`

    - `"SPOOF"`

    - `"SPAM"`

    - `"BULK"`

    - `"ENCRYPTED"`

    - `"EXTERNAL"`

    - `"UNKNOWN"`

    - `"NONE"`

  - `fields: Fields`

    - `to: List[str]`

    - `from_: Optional[str]`

    - `occurred_at: Optional[datetime]`

    - `postfix_id: Optional[str]`

    - `ts: Optional[datetime]`

      Deprecated, use `occurred_at` instead

  - `priority: str`

  - `title: str`

  - `created_at: Optional[datetime]`

  - `tags: Optional[List[Tag]]`

    - `category: str`

    - `value: str`

  - `ts: Optional[datetime]`

    Deprecated, use `created_at` instead

  - `updated_at: Optional[datetime]`