:::endpoint GET /v1/admin/fraud/summary

The numbers around the [flags](/docs/api/admin/fraud-flags): how many each view
holds with the filters given, so a segmented control can say what a tap shows,
and the two numbers beside the title of the Review queue.

`enabled` is false while the firm has switched fraud detection off, in which
case no new flag arrives. Switching it on is a part of
[the detectors](/docs/api/admin/fraud-detection-update).

Needs a firm. Our own staff name one with the `Propper-Workspace` header.

## Request

Takes the filters of the [flags](/docs/api/admin/fraud-flags) (`category`,
`level`, `restricted` and `q`) and counts with them. `view` and `sort` are
not read here.

```bash
curl "https://api.proppertrading.com/v1/admin/fraud/summary" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme"
```

## Response

{
    "data": {
        "object": "fraud_summary",
        "enabled": true,
        "counts": {
            "open": 52,
            "monitor": 5,
            "closed": 5,
            "all": 62
        },
        "restricted": 6,
        "suspended": 1
    },
    "meta": {
        "request_id": "req_01m50zcktdxddr7vbw48rna0zm"
    }
}

| Field        | Description |
| ------------ | ----------- |
| `counts`     | Flags per view with the filters given: `open`, `monitor`, `closed` and `all` |
| `restricted` | Traders under at least one restriction right now, whatever the filters |
| `suspended`  | Flags whose status is `auto_suspended`, whatever the filters. It counts flags, not people |

## Errors

| Status | Code                      | Meaning                                                                          |
| ------ | ------------------------- | -------------------------------------------------------------------------------- |
| 400    | `workspace_required`      | Asked by our own staff without naming a firm                                     |
| 400    | `validation_failed`       | `category`, `level` or `restricted` is not one of its values, or `q` is not text |
| 401    | `invalid_token`           | Not a token, or the secret does not match                                        |
| 401    | `revoked_token`           | Signed out here or from another device                                           |
| 401    | `expired_token`           | Ninety days without use, or a set expiry passed                                  |
| 403    | `admin_access_required`   | This account no longer helps run the environment                                 |
| 403    | `insufficient_scope`      | This device does not hold `admin:read`                                           |
| 403    | `workspace_not_permitted` | The `Propper-Workspace` header names an environment this account cannot act in   |
| 403    | `forbidden`               | Without `view_fraud`                                                             |