Usage

Represents the usage data of a usage plan.

APIs.ioEngineeringPlatform

Properties

Name Type Description
usagePlanId object
startDate object
endDate object
position object
items object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-usage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Usage",
  "title": "Usage",
  "type": "object",
  "properties": {
    "usagePlanId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The plan Id associated with this usage data."
        }
      ]
    },
    "startDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The starting date of the usage data."
        }
      ]
    },
    "endDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The ending date of the usage data."
        }
      ]
    },
    "position": {
      "$ref": "#/components/schemas/String"
    },
    "items": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfKeyUsages"
        },
        {
          "xml": {
            "name": "values"
          },
          "description": "The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, <code>{..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}</code>, where <code>{api_key}</code> stands for an API key value and the daily log entry is of the format <code>[used quota, remaining quota]</code>."
        }
      ]
    }
  },
  "description": "Represents the usage data of a usage plan."
}