Report Usage

Reports usage of a metered feature for a customer.

Mutation

mutation ReportUsage($input: ReportUsageInput!) {
  reportUsage(input: $input) {
    measurementId
    currentUsage
  }
}

{
  "input": {
    "customerId": "customer-123",
    "featureId": "feature-api-calls",
    "value": 100
  }
}

{
  "data": {
    "reportUsage": {
      "measurementId": "measure-789",
      "currentUsage": 4632
    }
  }
}

Parameters

ReportUsageInput

required

Input for reporting usage

Show properties

String

required

Customer reference ID

String

required

Feature reference ID

Float

required

Usage value to report

String

Resource ID for multi-resource

UsageUpdateBehavior

DELTA (add to current) or SET (replace current)

DateTime

Timestamp of when the usage was recorded

JSON

Additional dimensions for the usage report

UUID

Environment ID

Return Type

Returns a UsageMeasurementWithCurrentUsage with:

Field	Type	Description
`measurementId`	String	Measurement ID
`currentUsage`	Float	Updated current usage

Update Behaviors

Behavior	Description
`DELTA`	Add value to current usage (default)
`SET`	Set current usage to value

Examples

Increment Usage

{
  "input": {
    "customerId": "customer-123",
    "featureId": "feature-api-calls",
    "value": 100,
    "updateBehavior": "DELTA"
  }
}

Set Absolute Value

{
  "input": {
    "customerId": "customer-123",
    "featureId": "feature-storage",
    "value": 5.5,
    "updateBehavior": "SET"
  }
}

Common Use Cases

API call tracking

Report API calls as they happen for rate limiting.

Storage metering

Update storage usage periodically.

Event-based billing

Report usage events for billing calculation.

Report Usage Bulk - Bulk reporting
Usage History - Query history

Overview

SDKs

Queries

Mutations

Types

Report Usage

Mutation

Parameters

Return Type

Update Behaviors

Examples

Increment Usage

Set Absolute Value

Common Use Cases

​Mutation

​Parameters

​Return Type

​Update Behaviors

​Examples

​Increment Usage

​Set Absolute Value

​Common Use Cases

​Related Operations

Mutation

Parameters

Return Type

Update Behaviors

Examples

Increment Usage

Set Absolute Value

Common Use Cases

Related Operations