---
title: "Describe stats"
method: GET
path: "/stats/describe"
tags: ["Stats"]
---

# Describe stats

`GET /stats/describe`

Describe available stats schema. Without resource returns root nodes and metrics. With resource returns node columns, associations, and available metrics.

Required permissions:
 - `stats:read`

## Query parameters

- `resource` string — Resource path using : as separator (e.g., 'receipts', 'payments:membership', 'receipts:gross_revenue').
- `user_id` string — Scope query to a specific user.
- `account_id` string — Scope query to a specific company.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `422` — Verification required
- `429` — Too many requests
- `500` — Internal server error

## Changes

> 58 revisions in range; 1 not diffed.

- **2026-09-03** `697924df40d1` — 1 warning, 1 info
  - deleted the `query` request parameter `company_id`
  - added the new optional `query` request parameter `account_id`

[Change history](https://skmtc.dev/whop/apis/whop-api/changes/stats/describe/get.md)

---

[API](https://skmtc.dev/whop/apis/whop-api.md) · [All operations](https://skmtc.dev/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whop/apis/whop-api/revisions/14e4732f295d?raw)