List Marketing Payout Reports

GET 
/v2/report/marketing-payouts

List Marketing Payout Reports

Request

Query Parameters

page integer

Zero based page number of the reports to retrieve

size integer

Possible values: >= 1

Default value: 20

The number of reports to retrieve

Responses

200

list-marketing-payout-reports 200 response

application/json

Schema

Schema

content object[]required
Array [
id uuid
period string
partner_id uuid
total_commission int64
report_key string
report_bucket string
partner_payout_ach_id uuid
is_test boolean
paid boolean
payout_report_status PayoutReportStatus
Possible values: [INTERNAL_REVIEW, PUBLISHED]
]
pageable objectrequired
order_by object[]required
Array [
ignore_case booleanrequired
direction Sort.Order.Directionrequired
Possible values: [ASC, DESC]
property stringrequired
ascending boolean
]
number int32
size int32required
sort objectrequired
order_by object[]required
Array [
ignore_case booleanrequired
direction Sort.Order.Directionrequired
Possible values: [ASC, DESC]
property stringrequired
ascending boolean
]
page_number int32
offset int64
size int32
empty boolean
number_of_elements int32
totalSize int64required
totalPages int32

Example (from schema)

{
  "content": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "period": "string",
      "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "total_commission": 0,
      "report_key": "string",
      "report_bucket": "string",
      "partner_payout_ach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_test": true,
      "paid": true,
      "payout_report_status": "INTERNAL_REVIEW"
    }
  ],
  "pageable": {
    "order_by": [
      {
        "ignore_case": true,
        "direction": "ASC",
        "property": "string",
        "ascending": true
      }
    ],
    "number": 0,
    "size": 0,
    "sort": {
      "order_by": [
        {
          "ignore_case": true,
          "direction": "ASC",
          "property": "string",
          "ascending": true
        }
      ]
    }
  },
  "page_number": 0,
  "offset": 0,
  "size": 0,
  "empty": true,
  "number_of_elements": 0,
  "totalSize": 0,
  "totalPages": 0
}

Loading...