Skip to content
straddle API Docs
Get started
API Reference
Reports

Create Total Customers By Status

ReportCreateTotalCustomersByStatusResponse Reports.CreateTotalCustomersByStatus(ReportCreateTotalCustomersByStatusParams?parameters, CancellationTokencancellationToken = default)
POST/v1/reports/total_customers_by_status
ParametersExpand Collapse
ReportCreateTotalCustomersByStatusParams parameters
string correlationID

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

string requestID

Optional client generated identifier to trace and debug a request.

string straddleAccountID

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

formatuuid
ReturnsExpand Collapse
class ReportCreateTotalCustomersByStatusResponse:
required Data Data
required Int Inactive
required Int Pending
required Int Rejected
required Int Review
required Int Verified
required ResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
required ResponseType ResponseType

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"Object
"array"Array
"error"Error
"none"None

Create Total Customers By Status

ReportCreateTotalCustomersByStatusParams parameters = new();

var response = await client.Reports.CreateTotalCustomersByStatus(parameters);

Console.WriteLine(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"
}