# Reports

## 

`client.reports.createTotalCustomersByStatus(ReportCreateTotalCustomersByStatusParamsparams?, RequestOptionsoptions?): ReportCreateTotalCustomersByStatusResponse`

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

### Parameters

- `params: ReportCreateTotalCustomersByStatusParams`

  - `correlationID?: string`

    Optional client generated identifier to trace and debug a series of requests.

  - `requestID?: string`

    Optional client generated identifier to trace and debug a request.

  - `straddleAccountID?: string`

    For use by platforms to specify an account id and set scope of a request.

### Returns

- `ReportCreateTotalCustomersByStatusResponse`

  - `data: Data`

    - `inactive: number`

    - `pending: number`

    - `rejected: number`

    - `review: number`

    - `verified: number`

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "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

```typescript
import Straddle from '@straddlecom/straddle';

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

const response = await client.reports.createTotalCustomersByStatus();

console.log(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

- `ReportCreateTotalCustomersByStatusResponse`

  - `data: Data`

    - `inactive: number`

    - `pending: number`

    - `rejected: number`

    - `review: number`

    - `verified: number`

  - `meta: ResponseMetadata`

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

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: "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"`