Create Total Customers By Status

reports.create_total_customers_by_status(**kwargs) -> ReportCreateTotalCustomersByStatusResponse { data, meta, response_type }

post/v1/reports/total_customers_by_status

ParametersExpand Collapse

correlation_id: String

request_id: String

straddle_account_id: String

ReturnsExpand 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.

Accepts one of the following:

:object

:array

:error

:none

require "straddle"

straddle = Straddle::Client.new(
  api_key: "My API Key",
  environment: "production" # defaults to "sandbox"
)

response = straddle.reports.create_total_customers_by_status

puts(response)

{
  "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"
}

Returns Examples

{
  "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"
}