Skip to content
straddle API Docs
Get started
API Reference

Reports

Create Total Customers By Status
reports.create_total_customers_by_status(ReportCreateTotalCustomersByStatusParams**kwargs) -> ReportCreateTotalCustomersByStatusResponse
POST/v1/reports/total_customers_by_status
ModelsExpand Collapse
class ReportCreateTotalCustomersByStatusResponse: …
data: Data
inactive: int
pending: int
rejected: int
review: int
verified: int

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid
api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

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