ConstantsDefinitions

listInsightMetrics

GET
/api/v1/const/insight_metrics

Return supported insight metric names and metadata used by insight and SLE APIs.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Response Body

curl -X GET "https://example.com/api/v1/const/insight_metrics"
{  "bytes": {    "description": "Aggregated bytes over time",    "example": [      185,      197,      250    ],    "intervals": {      "10m": {        "interval": 600,        "max_age": 86400      },      "1h": {        "interval": 3600,        "max_age": 1209600      }    },    "report_durations": {      "1d": {        "duration": 86400,        "interval": 3600      },      "1w": {        "duration": 604800,        "interval": 3600      }    },    "report_scopes": [      "site",      "org"    ],    "scopes": [      "site",      "ap",      "client"    ],    "type": "timeseries",    "unit": "byte"  },  "num_clients": {    "description": "Number of client over time",    "example": [      18,      null,      15    ],    "intervals": {      "10m": {        "interval": 600,        "max_age": 86400      },      "1h": {        "interval": 3600,        "max_age": 1209600      }    },    "report_durations": {      "1d": {        "duration": 86400,        "interval": 3600      },      "1w": {        "duration": 604800,        "interval": 3600      }    },    "report_scopes": [      "site",      "org"    ],    "scopes": [      "site",      "ap",      "device"    ],    "type": "timeseries",    "unit": ""  }}