OpenAPI 3.1.02026-08-203914235.9 MB

6a23760847c8

Stats

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

Resource path using : as separator (e.g., 'receipts', 'payments:membership', 'receipts:gross_revenue').

company_idstring

Scope query to a specific company.

Example:biz_xxxxxxxxxxxxxx
user_idstring

Scope query to a specific user.

Example:user_xxxxxxxxxxxxx