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
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Query Parameters
Resource path using : as separator (e.g., 'receipts', 'payments:membership', 'receipts:gross_revenue').
Scope query to a specific company.
"biz_xxxxxxxxxxxxxx"
Scope query to a specific user.
"user_xxxxxxxxxxxxx"
Response
A successful response
- DescribeRoot
- DescribeNode
- DescribeMetric
- DescribeView
Root schema description showing available nodes, views, and metrics.
Debug information.
Available metrics.
Available root nodes.
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
The typename of this object
"DescribeRoot"Available API resource views.
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

