---
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, nullable — Resource path using : as separator (e.g., 'receipts', 'payments:membership', 'receipts:gross_revenue').
- `company_id` string, nullable — Scope query to a specific company.
- `user_id` string, nullable — Scope query to a specific user.

## Other responses

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

---

[API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/db0883548bc5/schema)