Skip to content
straddle API Docs
Get started
API Reference
Reports

Create Total Customers By Status

client.Reports.NewTotalCustomersByStatus(ctx, body) (*ReportNewTotalCustomersByStatusResponse, error)
POST/v1/reports/total_customers_by_status
ParametersExpand Collapse
body ReportNewTotalCustomersByStatusParams
CorrelationID param.Field[string]optional

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

RequestID param.Field[string]optional

Optional client generated identifier to trace and debug a request.

StraddleAccountID param.Field[string]optional

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

formatuuid
ReturnsExpand Collapse
type ReportNewTotalCustomersByStatusResponse struct{…}
Data ReportNewTotalCustomersByStatusResponseData
Inactive int64
Pending int64
Rejected int64
Review int64
Verified int64

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

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid
APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time
ResponseType ReportNewTotalCustomersByStatusResponseResponseType

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:
const ReportNewTotalCustomersByStatusResponseResponseTypeObject ReportNewTotalCustomersByStatusResponseResponseType = "object"
const ReportNewTotalCustomersByStatusResponseResponseTypeArray ReportNewTotalCustomersByStatusResponseResponseType = "array"
const ReportNewTotalCustomersByStatusResponseResponseTypeError ReportNewTotalCustomersByStatusResponseResponseType = "error"
const ReportNewTotalCustomersByStatusResponseResponseTypeNone ReportNewTotalCustomersByStatusResponseResponseType = "none"

Create Total Customers By Status

package main

import (
  "context"
  "fmt"

  "github.com/straddleio/straddle-go"
  "github.com/straddleio/straddle-go/option"
)

func main() {
  client := straddle.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Reports.NewTotalCustomersByStatus(context.TODO(), straddle.ReportNewTotalCustomersByStatusParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

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