Skip to content
Docs

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 API key's full subtree is always the outer bound). 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

  • granularitystring

    One of daily monthly · Default "daily"

  • date_fromstring · date
  • date_tostring · date
  • workspace_idarray of string · uuid
  • datastream_idarray of string · uuid
  • pageinteger

    Default 1 · Min 1

  • page_sizeinteger

    Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedUsageItemSchema

  • itemsarray of objectrequired
    Items · UsageItemSchema
    • datestring · daterequired
    • workspace_idstring · uuidrequired
    • workspace_namestringrequired
    • datastream_idstring · uuidnullable
      Attributes

      • string · uuid

      • null

    • unique_rowsintegerrequired
    • total_rowsintegerrequired
  • countintegerrequired
Was this page helpful?