WHwhatnot
Reports and Statements

Generate a report

Request a report generation run and return it. report_type selects the kind of report and the parameters it accepts. The run is created pending; generation happens asynchronously. When an identical request is already in flight or recently completed, that existing run is returned instead of starting a new one. Requires write:reports.

post/reports

Request

  • Base URL
    https://api.whatnot.com/seller-api/rest/v2
  • URL
    https://api.whatnot.com/seller-api/rest/v2/reports
  • Auth
    OAuth 2
    Authorization code: https://api.whatnot.com/seller-api/rest/oauth/authorize
    Token URL: https://api.whatnot.com/seller-api/rest/oauth/token

Request body

Example request

{
  "report_parameters": {
    "end_date": "2026-09-08T00:00:00.000Z",
    "report_type": "seller_financial_report",
    "start_date": "2026-09-01T00:00:00.000Z"
  }
}

Response

The run that will produce the report.

idstring uuid required

The report run's ID.

report_type'seller_financial_report' | 'analytics_overview_report' | 'analytics_livestreams_report' required
status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' required
report_urlstring nullable required

URL of the generated report file. Null until the run is completed. See Reports and Statements for each report type's CSV columns.

created_atstring date-time required

When the run was requested.

updated_atstring date-time required

When the run was last updated.

Example response

{
  "created_at": "2026-09-20T18:30:00.000Z",
  "id": "0199a7c2-3f4e-7a1b-9c2d-4e5f6a7b8c9d",
  "report_parameters": {
    "end_date": "2026-09-08T00:00:00.000Z",
    "report_type": "seller_financial_report",
    "start_date": "2026-09-01T00:00:00.000Z"
  },
  "report_type": "seller_financial_report",
  "status": "pending",
  "updated_at": "2026-09-20T18:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.