Cove Data Protection icon

Cove Data Protection

Interact with Cove Data Protection API

Account → Get Statistics

AI-generated

Summary

Retrieve account statistics for a specified partner with selectable statistics columns and optional filtering and selection mode.

Inputs

  • Partner Name or ID (required) — The partner to enumerate account statistics for. Choose from the list, or specify an ID using an expression.
  • Columns — Statistics columns to retrieve, selectable via multiOptions with column codes (e.g., Device ID (I0), Device Name (I1), Creation Date (I4), Used Storage (I14), Computer Name (I18), etc.). Defaults to ['I0','I1','I4','I14','I18'].
  • Additional Options — Optional filter expression (e.g., "ANY =~ "Device*"") and selection mode ('Merged' or 'Detailed (Per Installation)'). Defaults to 'Merged'.
  • Return All — Whether to return all matching results or limit the number of returned entries. Defaults to true (return all).
  • Limit — Maximum number of results to return if 'Return All' is false. Minimum 1, default 50.

Output shape

a list of account statistics records

Each returned record includes accountId, partnerId, flags, and properties for each selected statistics column mapped to descriptive field names (e.g., deviceId, deviceName, creationDate). Supports optional pagination via 'Return All' and 'Limit' parameters. If a filter expression is specified, results are filtered accordingly. Selection Mode influences how statistics are aggregated or detailed.

Examples

Example 1: Get Statistics for Partner

Specify Partner Name or ID, optionally select which columns of account statistics to retrieve, optionally apply a filter or change selection mode, and set whether to return all or limit results.

Links

Discussion