countOrgVars
Count organization vars, optionally grouped by distinct and filtered by site, variable name, and source.
Example: /api/v1/orgs/{org_id}/vars/count?distinct=var
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidQuery Parameters
Field used to group this count response. enum: site_id, src, var
"var"Value in
- "site_id"
- "src"
- "var"
Filter results by site identifier. Accepts multiple comma-separated values.
Filter variable results by variable name. Accepts multiple comma-separated values.
Filter results by source. enum: deviceprofile, site
Value in
- "deviceprofile"
- "site"
Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"Maximum number of results to return per page
0 <= value100Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/vars/count"{ "distinct": "string", "end": 0, "limit": 0, "results": [ { "count": 0, "property": "string" } ], "start": 0, "total": 0}