v9
OpenAPI 3.1.02026-08-043703845.2 MBStats
Describe stats
Describe available stats schema. Without resource returns root nodes and metrics. With resource returns node columns, associations, and available metrics.
Required permissions:
- stats:read
get/stats/describe
Query parameters
resourcestring nullable
Resource path using : as separator (e.g., 'receipts', 'payments:membership', 'receipts:gross_revenue').
company_idstring nullable
Scope query to a specific company.
Example:biz_xxxxxxxxxxxxxx
user_idstring nullable
Scope query to a specific user.
Example:user_xxxxxxxxxxxxx