Sign in
Stats

List Reports

Changed on

Lists every report: the aggregates that are not bucketed over time. Each entry names the report's path, its window kind, the breakdowns it accepts and its columns. A property column is an attribute of the row and lists the breakdowns it can ride along with. A metric column is a number measured over the row, with the unit that sets its JSON type, the aggregate that says how to combine it across rows, and the breakdowns and windows it supports. For a bucketed series, use GET /stats/time_series.

get/stats/reports

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/stats/reports
  • Auth: HTTP bearer

Response

Every report you can retrieve.

Example response

{
  "data": [
    {
      "breakdowns": [
        "industry_type"
      ],
      "columns": [
        {
          "aggregate": "sum",
          "available_on": [
            "industry_type"
          ],
          "key": "industry_type",
          "name": "Industry type",
          "set": "open",
          "type": "property",
          "unit": "money"
        }
      ],
      "description": "Payments across all of Whop, by business type, industry type, account country or customer country.",
      "key": "platform_trends",
      "path": "/api/v1/stats/reports/platform_trends",
      "window_field": "paid_at",
      "window_kind": "range"
    }
  ]
}

Changes