Endpoint

/v1/analytics/capacity-history/{timestamp}/

GET

Returns all paths using more than 0.1% of overall used capacity at a given timestamp. A path that meets the threshold with many items smaller than the threshold will be aggregated. Individual items above the threshold will be reported separately.

Parameters

Name Description Required
timestamp Time in epoch seconds Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "historical_capacity_details",
  "type": "object",
  "properties": {
    "threshold_for_inclusion": {
      "description": "threshold_for_inclusion",
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "UNAVAILABLE",
        "PENDING"
      ],
      "description": "status:\n * `AVAILABLE` - DETAILED_PATH_CAPACITY_AVAILABLE,\n * `PENDING` - DETAILED_PATH_CAPACITY_PENDING,\n * `UNAVAILABLE` - DETAILED_PATH_CAPACITY_UNAVAILABLE"
    },
    "largest_paths": {
      "type": "array",
      "items": {
        "description": "largest_paths",
        "type": "object",
        "properties": {
          "capacity_used": {
            "description": "capacity_used",
            "type": "string"
          },
          "path": {
            "description": "path",
            "type": "string"
          }
        }
      }
    }
  }
}