Skip to content
straddle API Docs
Get started
API Reference

Reports

Create Total Customers By Status
client.reports.createTotalCustomersByStatus(ReportCreateTotalCustomersByStatusParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): ReportCreateTotalCustomersByStatusResponse { data, meta, response_type }
POST/v1/reports/total_customers_by_status
ModelsExpand Collapse
ReportCreateTotalCustomersByStatusResponse { data, meta, response_type }
data: Data { inactive, pending, rejected, 2 more }
inactive: number
pending: number
rejected: number
review: number
verified: number
meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time
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.
One of the following:
"object"
"array"
"error"
"none"