# Reports

## 

`reports.create_total_customers_by_status(ReportCreateTotalCustomersByStatusParams**kwargs)  -> ReportCreateTotalCustomersByStatusResponse`

**post** `/v1/reports/total_customers_by_status`

### Parameters

- `correlation_id: Optional[str]`

- `request_id: Optional[str]`

- `straddle_account_id: Optional[str]`

### Returns

- `class ReportCreateTotalCustomersByStatusResponse: …`

  - `data: Data`

    - `inactive: int`

    - `pending: int`

    - `rejected: int`

    - `review: int`

    - `verified: int`

  - `meta: ResponseMetadata`

    Metadata about the API request, including an identifier and timestamp.

    - `api_request_id: str`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: datetime`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: Literal["object", "array", "error", "none"]`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```python
import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
response = client.reports.create_total_customers_by_status()
print(response.data)
```

#### Response

```json
{
  "data": {
    "inactive": 0,
    "pending": 0,
    "rejected": 0,
    "review": 0,
    "verified": 0
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```

## Domain Types

### Report Create Total Customers By Status Response

- `class ReportCreateTotalCustomersByStatusResponse: …`

  - `data: Data`

    - `inactive: int`

    - `pending: int`

    - `rejected: int`

    - `review: int`

    - `verified: int`

  - `meta: ResponseMetadata`

    Metadata about the API request, including an identifier and timestamp.

    - `api_request_id: str`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: datetime`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: Literal["object", "array", "error", "none"]`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`