Skip to content
straddle API Docs
Get started
API Reference

Reports

Create Total Customers By Status
reports.create_total_customers_by_status(**kwargs) -> ReportCreateTotalCustomersByStatusResponse { data, meta, response_type }
POST/v1/reports/total_customers_by_status
ModelsExpand Collapse
class ReportCreateTotalCustomersByStatusResponse { data, meta, response_type }
data: { inactive, pending, rejected, 2 more}
inactive: Integer
pending: Integer
rejected: Integer
review: Integer
verified: Integer
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: Time

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