Skip to main content

customerTotalUsageMetrics Query

Returns a Relay Connection to a collection of CustomerTotalUsageMetrics objects.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_customer_permissions, org_manage_customers, org_view_customers]. 2. The signed-in User has any of the following permissions for the object: [customer_view, customer_edit, customer_remove, customer_admin_users, customer_view_users, customer_admin_instance_permissions, customer_view_instances].

Input fields

ArgumentTypeDescription
beforeStringSpecifies a cursor for use in combination with last to implement backward pagination.
afterStringSpecifies a cursor for use in combination with first to implement forward pagination.
firstIntA non-negative integer that specifies to return at most first edges after the after cursor.
lastIntA non-negative integer that specifies to return at most last edges before the before cursor.
offsetInt
snapshotTime_GteDateTimeFilter for objects where snapshotTime occurs on or after the specified value.
snapshotTime_LteDateTimeFilter for objects where snapshotTime occurs on or before the specified value.
customerIDFilter for objects where customer matches the specified ID.
orderByCustomerTotalUsageMetricsOrderDEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy[CustomerTotalUsageMetricsOrder]Allows specifying many field and direction pairs to sort results by.

Return fields (CustomerTotalUsageMetricsConnection!)

edges ([CustomerTotalUsageMetricsEdge]!)

List of edges containing the nodes in this connection.

nodes ([CustomerTotalUsageMetrics]!)

List of nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total count of nodes available.