Red Hat 3scale · Schema

UsageStats

API GatewayAPI ManagementDeveloper PortalEnterpriseRed Hat

Properties

Name Type Description
metric string The metric name
period string The time period
period_start string
period_end string
total integer Total value for the period
values array Time-series data points
View JSON Schema on GitHub

JSON Schema

red-hat-3scale-usagestats-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UsageStats",
  "title": "UsageStats",
  "type": "object",
  "properties": {
    "metric": {
      "type": "string",
      "description": "The metric name"
    },
    "period": {
      "type": "string",
      "description": "The time period"
    },
    "period_start": {
      "type": "string",
      "format": "date-time"
    },
    "period_end": {
      "type": "string",
      "format": "date-time"
    },
    "total": {
      "type": "integer",
      "description": "Total value for the period"
    },
    "values": {
      "type": "array",
      "description": "Time-series data points",
      "items": {
        "type": "array",
        "items": {
          "oneOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "integer"
            }
          ]
        }
      }
    }
  }
}