MeterDefinition

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amberflo/refs/heads/main/json-schema/metering-meter-definition-schema.json",
  "title": "MeterDefinition",
  "description": "A meter definition that specifies how usage events are tracked and aggregated",
  "type": "object",
  "properties": {
    "meterApiName": {
      "type": "string",
      "description": "Unique API name for the meter",
      "example": "api-calls"
    },
    "displayName": {
      "type": "string",
      "description": "Human-readable display name for the meter",
      "example": "API Calls"
    },
    "label": {
      "type": "string",
      "description": "Label identifier for the meter",
      "example": "api-calls"
    },
    "type": {
      "type": "string",
      "description": "Aggregation type for the meter",
      "enum": [
        "SUM_OF_ALL_USAGE",
        "MAX_IN_PERIOD",
        "UNIQUE_CUSTOMERS_COUNT"
      ],
      "example": "SUM_OF_ALL_USAGE"
    },
    "meterTimeInMillis": {
      "type": "integer",
      "format": "int64",
      "description": "Creation timestamp in Unix milliseconds",
      "example": 1718153645993
    },
    "dimensions": {
      "type": "array",
      "description": "List of dimension names for this meter",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "meterApiName",
    "displayName",
    "type"
  ]
}