Usage
1 operation in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.
List row usage per workspace
GET/api/v1/usage/
API key permissionUsage: Read-onlyusage:read
Retrieve finalized row usage (unique and total rows) grouped by date, workspace, and datastream, scoped to the API key's workspace hierarchy. Supports daily and monthly granularity. Only finalized data (through yesterday) is returned; the current day is excluded until daily aggregation completes. If date_from is omitted it defaults to the first of the anchor month (date_to's month when date_to is given, otherwise the current month, or the previous month on the 1st when the current month has no finalized days yet), so the window is always bounded; set date_from explicitly to query a wider range. Use workspace_id / datastream_id to narrow within the accessible hierarchy: workspace_id matches the given workspace(s) exactly and does NOT roll up descendants (the workspaces the API key can reach are always the outer bound: its own workspace and descendants, without those scheduled for deletion). Both workspace_id and datastream_id accept multiple values; repeat the parameter to filter on a set (e.g. ?workspace_id=<uuid>&workspace_id=<uuid>).
Query parameters
granularitystringOne of
dailymonthly· Default"daily"date_fromstring · datedate_tostring · dateworkspace_idarray of string · uuiddatastream_idarray of string · uuidpageintegerDefault
1· Min1page_sizeintegerDefault
50· Min1
Responses
200OKapplication/json
Response schema
object PagedUsageItemSchema
itemsarray of objectrequiredItems · UsageItemSchema
datestring · daterequiredworkspace_idstring · uuidrequiredworkspace_namestringrequireddatastream_idstring · uuidnullableAttributes
string · uuid
null
unique_rowsintegerrequiredtotal_rowsintegerrequired
countintegerrequired