Skip to main content

Get Aggregator Usage​

This API can be used to obtain usage data for the Aggregator for the given usage month. All dates in usage API refer to UTC time zone. Usage shown is the peak usage in the given usage month.

Get usage and cost data for all accounts under the Aggregator. Account can either be direct account under the Aggregator, or Sub MSP account associated with a Sub MSP under the Aggregator.

Query Parameters
  • usageMonth date

    The month for which usage is returned. Time zone is UTC. Format is "YYYY-MM-DD".

  • subMspId string

    Sub MSP ID. Supply this parameter to retrieve usage for accounts under certain Sub MSP or direct accounts under Aggregator.

  • sort string

    Sort parameter. Schema is order:fieldName. If not provided, default asc:subMspName,asc:accountName,asc:skuId.

  • pageNumber integer

    Pagination parameter. If not provided, default 0.

  • pageSize integer

    Possible values: >= 1 and <= 1000

    Pagination parameter. If not provided, default 100.

Responses

Success

Schema
  • data object[]
  • usageMonth string

    Calendar month for which usage is returned

  • subMspId uuid

    Sub MSP ID in Commvault

  • subMspName string

    Sub MSP name in Commvault

  • externalSubMspId string

    Sub MSP ID in Partner System

  • accountId uuid

    Account ID in Commvault

  • accountName string

    Account Name in Commvault

  • externalAccountId string

    Account ID in Partner System

  • skuId string

    Service sku ID

  • consumedQuantity number

    Peak usage quantity in usage month. This quantity is using measurement of service unit quantity

  • entitledQuantity number

    Pre-commited quantity in usage month. For commit skus, it's purchased quantity sent in fulfillment

  • overageQuantity number

    Quantity used more than entitled quantity in usage month

  • billableQuantity number

    Quantity that will be charged in usage month

  • unitPrice number

    Price for a single unit

  • unitQuantity number

    Service unit quantity

  • unit string

    Service unit

  • cost number

    Cost for account in the usage month

  • currency string

    Billing currency

  • metadata object
  • filter string

    Filter string that contains search parameters

  • sort string

    Sort string that contains sorting criteria

  • pagination object
  • pageNumber integer
  • pageSize integer
  • totalRecords integer
Loading...