openapi: 3.2.0 info: title: Mist Sites SLEs API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Sites SLEs description: Site SLEs, or Service-Level Expectations, are metrics used to monitor and report on the user experience of a Wireless, Wired or Wan network. paths: /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/classifier/{classifier}/summary: parameters: [] get: tags: - Sites SLEs summary: getSiteSleClassifierDetails description: 'Get SLE classifier details This API Endpoint is deprecated and replaced by Get Site SLE Classifier Summary Trend' operationId: getSiteSleClassifierDetails parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/sle_summary_scope' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: classifier in: path description: '' required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_classifier_summary' - description: Deprecated SLE classifier summary response examples: - classifier: impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 20 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 failures: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 metric: capacity start: 1627226471 contentMediaType: application/json examples: Example: value: classifier: impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 20 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 failures: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 metric: capacity start: 1627226471 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_classifier_summary' - description: Deprecated SLE classifier summary response examples: - classifier: impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 20 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 failures: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 metric: capacity start: 1627226471 contentMediaType: application/vnd.api+json examples: Example: value: classifier: impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 20 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 failures: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 metric: capacity start: 1627226471 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: true /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/classifier/{classifier}/summary-trend: parameters: [] get: tags: - Sites SLEs summary: getSiteSleClassifierSummaryTrend description: Get SLE classifier Summary Trend operationId: getSiteSleClassifierSummaryTrend parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/sle_summary_scope' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: classifier in: path description: '' required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_classifier_summary_trend' - description: Time-series trend response for an SLE classifier examples: - classifier: interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 metric: capacity start: 1627226471 contentMediaType: application/json examples: Example: value: classifier: interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 metric: capacity start: 1627226471 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_classifier_summary_trend' - description: Time-series trend response for an SLE classifier examples: - classifier: interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 metric: capacity start: 1627226471 contentMediaType: application/vnd.api+json examples: Example: value: classifier: interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 444.13333 x_label: seconds y_label: user-minutes end: 1627312871 metric: capacity start: 1627226471 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/classifiers: parameters: [] get: tags: - Sites SLEs summary: listSiteSleMetricClassifiers description: List classifiers for a specific metric operationId: listSiteSleMetricClassifiers parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_metric_classifiers_scope_parameters' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: uniqueItems: true type: array items: type: string description: Unique string values returned or accepted by this schema examples: - - asymmetry-uplink - weak-signal - asymmetry-downlink contentMediaType: application/json examples: example: value: - asymmetry-uplink - weak-signal - asymmetry-downlink '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/histogram: parameters: [] get: tags: - Sites SLEs summary: getSiteSleHistogram description: Get the histogram for the SLE metric operationId: getSiteSleHistogram parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_histogram_scope_parameters' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_histogram' - description: Histogram response for an SLE metric examples: - data: - range: - null - 0 value: 0 - range: - 0 - 10 value: 0 - range: - 10 - 20 value: 5105 - range: - 20 - 30 value: 10616 - range: - 30 - 40 value: 40051 - range: - 40 - 50 value: 141201 - range: - 50 - 60 value: 949823 - range: - 60 - 70 value: 686308 - range: - 70 - 80 value: 177670 - range: - 80 - 90 value: 689 - range: - 90 - 100 value: 0 - range: - 100 - null value: 0 end: 1627055181 metric: capacity start: 1626968781 x_label: available_bandwidth(%) y_label: seconds contentMediaType: application/json examples: Example: value: data: - range: - null - 0 value: 0 - range: - 0 - 10 value: 0 - range: - 10 - 20 value: 5105 - range: - 20 - 30 value: 10616 - range: - 30 - 40 value: 40051 - range: - 40 - 50 value: 141201 - range: - 50 - 60 value: 949823 - range: - 60 - 70 value: 686308 - range: - 70 - 80 value: 177670 - range: - 80 - 90 value: 689 - range: - 90 - 100 value: 0 - range: - 100 - null value: 0 end: 1627055181 metric: capacity start: 1626968781 x_label: available_bandwidth(%) y_label: seconds application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_histogram' - description: Histogram response for an SLE metric examples: - data: - range: - null - 0 value: 0 - range: - 0 - 10 value: 0 - range: - 10 - 20 value: 5105 - range: - 20 - 30 value: 10616 - range: - 30 - 40 value: 40051 - range: - 40 - 50 value: 141201 - range: - 50 - 60 value: 949823 - range: - 60 - 70 value: 686308 - range: - 70 - 80 value: 177670 - range: - 80 - 90 value: 689 - range: - 90 - 100 value: 0 - range: - 100 - null value: 0 end: 1627055181 metric: capacity start: 1626968781 x_label: available_bandwidth(%) y_label: seconds contentMediaType: application/vnd.api+json examples: Example: value: data: - range: - null - 0 value: 0 - range: - 0 - 10 value: 0 - range: - 10 - 20 value: 5105 - range: - 20 - 30 value: 10616 - range: - 30 - 40 value: 40051 - range: - 40 - 50 value: 141201 - range: - 50 - 60 value: 949823 - range: - 60 - 70 value: 686308 - range: - 70 - 80 value: 177670 - range: - 80 - 90 value: 689 - range: - 90 - 100 value: 0 - range: - 100 - null value: 0 end: 1627055181 metric: capacity start: 1626968781 x_label: available_bandwidth(%) y_label: seconds '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impact-summary: parameters: [] get: tags: - Sites SLEs summary: getSiteSleImpactSummary description: 'Get impact summary counts optionally filtered by classifier and failure type * Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge` * Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis` * WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`' operationId: getSiteSleImpactSummary parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impact_summary_scope_parameters' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: fields in: query description: 'Additional response fields to include, as a comma-separated list or `*` for all fields. enum: `ap`, `band`, `chassis`, `client`, `device_os`, `device_type`, `gateway`, `gateway_zones`, `interface`, `mxedge`, `peer_path`, `server`, `switch`, `vlan`, `wlan`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/site_sle_impact_summary_fields_parameter' - description: 'Additional response fields to include, as a comma-separated list or `*` for all fields. enum: `ap`, `band`, `chassis`, `client`, `device_os`, `device_type`, `gateway`, `gateway_zones`, `interface`, `mxedge`, `peer_path`, `server`, `switch`, `vlan`, `wlan`' - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impact_summary' - description: SLE impact summary grouped by client, device, AP, WLAN, and band dimensions examples: - ap: - ap_mac: 5c5b3550bd2e degraded: 1486 duration: 0 name: ap43-off.lab total: 27406 - ap_mac: d420b083e17a degraded: 3 duration: 0 name: ap33-ent.lab total: 1193 band: - band: '24' degraded: 1410 duration: 0 name: '24' total: 28536 - band: '5' degraded: 78 duration: 0 name: '5' total: 4679 classifier: '' device_os: - degraded: 1329 device_os: '' duration: 0 name: unknown total: 27165 - degraded: 81 device_os: Linux duration: 0 name: Linux total: 1437 - degraded: 36 device_os: Android 11 duration: 0 name: Android 11 total: 761 - degraded: 39 device_os: '14.6' duration: 0 name: '14.6' total: 2413 - degraded: 2 device_os: Catalina duration: 0 name: Catalina total: 1438 device_type: - degraded: 1410 device_type: '' duration: 0 name: unknown total: 28603 - degraded: 2 device_type: iPhone duration: 0 name: iPhone total: 1263 - degraded: 36 device_type: OnePlus duration: 0 name: OnePlus total: 761 - degraded: 37 device_type: iPad duration: 0 name: iPad total: 1150 - degraded: 2 device_type: Mac duration: 0 name: Mac total: 1438 end: 1627312734 failure: '' metric: capacity start: 1627226334 wlan: - degraded: 37 duration: 0 name: MlN.ADM total: 1150 wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18 - degraded: 1410 duration: 0 name: MlN total: 28603 wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b - degraded: 41 duration: 0 name: MlN.1X total: 3462 wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483 contentMediaType: application/json examples: Example: value: ap: - ap_mac: 5c5b3550bd2e degraded: 1486 duration: 0 name: ap43-off.lab total: 27406 - ap_mac: d420b083e17a degraded: 3 duration: 0 name: ap33-ent.lab total: 1193 band: - band: '24' degraded: 1410 duration: 0 name: '24' total: 28536 - band: '5' degraded: 78 duration: 0 name: '5' total: 4679 classifier: '' device_os: - degraded: 1329 device_os: '' duration: 0 name: unknown total: 27165 - degraded: 81 device_os: Linux duration: 0 name: Linux total: 1437 - degraded: 36 device_os: Android 11 duration: 0 name: Android 11 total: 761 - degraded: 39 device_os: '14.6' duration: 0 name: '14.6' total: 2413 - degraded: 2 device_os: Catalina duration: 0 name: Catalina total: 1438 device_type: - degraded: 1410 device_type: '' duration: 0 name: unknown total: 28603 - degraded: 2 device_type: iPhone duration: 0 name: iPhone total: 1263 - degraded: 36 device_type: OnePlus duration: 0 name: OnePlus total: 761 - degraded: 37 device_type: iPad duration: 0 name: iPad total: 1150 - degraded: 2 device_type: Mac duration: 0 name: Mac total: 1438 end: 1627312734 failure: '' metric: capacity start: 1627226334 wlan: - degraded: 37 duration: 0 name: MlN.ADM total: 1150 wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18 - degraded: 1410 duration: 0 name: MlN total: 28603 wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b - degraded: 41 duration: 0 name: MlN.1X total: 3462 wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impact_summary' - description: SLE impact summary grouped by client, device, AP, WLAN, and band dimensions examples: - ap: - ap_mac: 5c5b3550bd2e degraded: 1486 duration: 0 name: ap43-off.lab total: 27406 - ap_mac: d420b083e17a degraded: 3 duration: 0 name: ap33-ent.lab total: 1193 band: - band: '24' degraded: 1410 duration: 0 name: '24' total: 28536 - band: '5' degraded: 78 duration: 0 name: '5' total: 4679 classifier: '' device_os: - degraded: 1329 device_os: '' duration: 0 name: unknown total: 27165 - degraded: 81 device_os: Linux duration: 0 name: Linux total: 1437 - degraded: 36 device_os: Android 11 duration: 0 name: Android 11 total: 761 - degraded: 39 device_os: '14.6' duration: 0 name: '14.6' total: 2413 - degraded: 2 device_os: Catalina duration: 0 name: Catalina total: 1438 device_type: - degraded: 1410 device_type: '' duration: 0 name: unknown total: 28603 - degraded: 2 device_type: iPhone duration: 0 name: iPhone total: 1263 - degraded: 36 device_type: OnePlus duration: 0 name: OnePlus total: 761 - degraded: 37 device_type: iPad duration: 0 name: iPad total: 1150 - degraded: 2 device_type: Mac duration: 0 name: Mac total: 1438 end: 1627312734 failure: '' metric: capacity start: 1627226334 wlan: - degraded: 37 duration: 0 name: MlN.ADM total: 1150 wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18 - degraded: 1410 duration: 0 name: MlN total: 28603 wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b - degraded: 41 duration: 0 name: MlN.1X total: 3462 wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483 contentMediaType: application/vnd.api+json examples: Example: value: ap: - ap_mac: 5c5b3550bd2e degraded: 1486 duration: 0 name: ap43-off.lab total: 27406 - ap_mac: d420b083e17a degraded: 3 duration: 0 name: ap33-ent.lab total: 1193 band: - band: '24' degraded: 1410 duration: 0 name: '24' total: 28536 - band: '5' degraded: 78 duration: 0 name: '5' total: 4679 classifier: '' device_os: - degraded: 1329 device_os: '' duration: 0 name: unknown total: 27165 - degraded: 81 device_os: Linux duration: 0 name: Linux total: 1437 - degraded: 36 device_os: Android 11 duration: 0 name: Android 11 total: 761 - degraded: 39 device_os: '14.6' duration: 0 name: '14.6' total: 2413 - degraded: 2 device_os: Catalina duration: 0 name: Catalina total: 1438 device_type: - degraded: 1410 device_type: '' duration: 0 name: unknown total: 28603 - degraded: 2 device_type: iPhone duration: 0 name: iPhone total: 1263 - degraded: 36 device_type: OnePlus duration: 0 name: OnePlus total: 761 - degraded: 37 device_type: iPad duration: 0 name: iPad total: 1150 - degraded: 2 device_type: Mac duration: 0 name: Mac total: 1438 end: 1627312734 failure: '' metric: capacity start: 1627226334 wlan: - degraded: 37 duration: 0 name: MlN.ADM total: 1150 wlan_id: ba3f85fc-ba48-4d8f-ad89-152e5c42db18 - degraded: 1410 duration: 0 name: MlN total: 28603 wlan_id: 649a2336-b1e0-47bd-961c-f637dbe50e7b - degraded: 41 duration: 0 name: MlN.1X total: 3462 wlan_id: a937da77-fe3c-4784-86c4-f2134d7b1483 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-applications: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedApplications description: For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type operationId: listSiteSleImpactedApplications parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_scope' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_applications' - description: Paginated list of applications impacted by an SLE metric examples: - apps: - app: ZOOM degraded: 371103 duration: 0 name: ZOOM threshold: 173 total: 1771274 classifier: '' end: 1668760746 failure: '' limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 contentMediaType: application/json examples: Example: value: apps: - app: ZOOM degraded: 371103 duration: 0 name: ZOOM threshold: 173 total: 1771274 classifier: '' end: 1668760746 failure: '' limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_applications' - description: Paginated list of applications impacted by an SLE metric examples: - apps: - app: ZOOM degraded: 371103 duration: 0 name: ZOOM threshold: 173 total: 1771274 classifier: '' end: 1668760746 failure: '' limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 contentMediaType: application/vnd.api+json examples: Example: value: apps: - app: ZOOM degraded: 371103 duration: 0 name: ZOOM threshold: 173 total: 1771274 classifier: '' end: 1668760746 failure: '' limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-aps: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedAps description: For Wireless SLEs. List the impacted APs optionally filtered by classifier and failure type operationId: listSiteSleImpactedAps parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_aps_scope_parameters' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_aps' - description: Paginated list of APs impacted by an SLE metric examples: - aps: - ap_mac: 5c5b35500000 degraded: 1486 duration: 0 name: ap43.lab total: 27377 - ap_mac: d420b0830000 degraded: 3 duration: 0 name: ap33.lab total: 1189 classifier: '' end: 1627313016 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226616 total_count: 2 contentMediaType: application/json examples: Example: value: aps: - ap_mac: 5c5b35500000 degraded: 1486 duration: 0 name: ap43.lab total: 27377 - ap_mac: d420b0830000 degraded: 3 duration: 0 name: ap33.lab total: 1189 classifier: '' end: 1627313016 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226616 total_count: 2 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_aps' - description: Paginated list of APs impacted by an SLE metric examples: - aps: - ap_mac: 5c5b35500000 degraded: 1486 duration: 0 name: ap43.lab total: 27377 - ap_mac: d420b0830000 degraded: 3 duration: 0 name: ap33.lab total: 1189 classifier: '' end: 1627313016 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226616 total_count: 2 contentMediaType: application/vnd.api+json examples: Example: value: aps: - ap_mac: 5c5b35500000 degraded: 1486 duration: 0 name: ap43.lab total: 27377 - ap_mac: d420b0830000 degraded: 3 duration: 0 name: ap33.lab total: 1189 classifier: '' end: 1627313016 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226616 total_count: 2 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-chassis: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedChassis description: For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type operationId: listSiteSleImpactedChassis parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_chassis_scope_parameters' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_chassis' - description: Paginated list of chassis impacted by an SLE metric examples: - chassis: - chassis: '1' degraded: 12.283334 duration: 13655.167 role: master switch_mac: d0dd49012345 switch_name: test-chassis total: 13655.167 classifier: '' end: 1668760643 failure: '' limit: 1000 metric: switch_health page: 1 start: 1668121200 total_count: 1 contentMediaType: application/json examples: Example: value: chassis: - chassis: '1' degraded: 12.283334 duration: 13655.167 role: master switch_mac: d0dd49012345 switch_name: test-chassis total: 13655.167 classifier: '' end: 1668760643 failure: '' limit: 1000 metric: switch_health page: 1 start: 1668121200 total_count: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_chassis' - description: Paginated list of chassis impacted by an SLE metric examples: - chassis: - chassis: '1' degraded: 12.283334 duration: 13655.167 role: master switch_mac: d0dd49012345 switch_name: test-chassis total: 13655.167 classifier: '' end: 1668760643 failure: '' limit: 1000 metric: switch_health page: 1 start: 1668121200 total_count: 1 contentMediaType: application/vnd.api+json examples: Example: value: chassis: - chassis: '1' degraded: 12.283334 duration: 13655.167 role: master switch_mac: d0dd49012345 switch_name: test-chassis total: 13655.167 classifier: '' end: 1668760643 failure: '' limit: 1000 metric: switch_health page: 1 start: 1668121200 total_count: 1 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-clients: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedWiredClients description: For Wired SLEs. List the impacted interfaces optionally filtered by classifier and failure type operationId: listSiteSleImpactedWiredClients parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_clients_scope_parameters' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_clients' - description: Paginated list of clients impacted by an SLE metric examples: - classifier: '' clients: - degraded: 40 duration: 11014 mac: '001122334455' name: test-device switches: - interfaces: - ge-0/0/6 switch_mac: 2c2131001122 switch_name: test-ex total: 11014 end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 1 contentMediaType: application/json examples: Example: value: classifier: '' clients: - degraded: 40 duration: 11014 mac: '001122334455' name: test-device switches: - interfaces: - ge-0/0/6 switch_mac: 2c2131001122 switch_name: test-ex total: 11014 end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_clients' - description: Paginated list of clients impacted by an SLE metric examples: - classifier: '' clients: - degraded: 40 duration: 11014 mac: '001122334455' name: test-device switches: - interfaces: - ge-0/0/6 switch_mac: 2c2131001122 switch_name: test-ex total: 11014 end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 1 contentMediaType: application/vnd.api+json examples: Example: value: classifier: '' clients: - degraded: 40 duration: 11014 mac: '001122334455' name: test-device switches: - interfaces: - ge-0/0/6 switch_mac: 2c2131001122 switch_name: test-ex total: 11014 end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 1 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-gateways: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedGateways description: For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type operationId: listSiteSleImpactedGateways parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_gateways_scope_parameters' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_gateways' - description: Paginated list of gateways impacted by an SLE metric examples: - classifier: '' end: 1668760746 failure: '' gateways: - degraded: 758573.1 duration: 2770997 gateway_mac: fc3342001122 gateway_model: SRX320 gateway_version: 20.4R1.12 name: test-SRX total: 2770997 limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 contentMediaType: application/json examples: Example: value: classifier: '' end: 1668760746 failure: '' gateways: - degraded: 758573.1 duration: 2770997 gateway_mac: fc3342001122 gateway_model: SRX320 gateway_version: 20.4R1.12 name: test-SRX total: 2770997 limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_gateways' - description: Paginated list of gateways impacted by an SLE metric examples: - classifier: '' end: 1668760746 failure: '' gateways: - degraded: 758573.1 duration: 2770997 gateway_mac: fc3342001122 gateway_model: SRX320 gateway_version: 20.4R1.12 name: test-SRX total: 2770997 limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 contentMediaType: application/vnd.api+json examples: Example: value: classifier: '' end: 1668760746 failure: '' gateways: - degraded: 758573.1 duration: 2770997 gateway_mac: fc3342001122 gateway_model: SRX320 gateway_version: 20.4R1.12 name: test-SRX total: 2770997 limit: 1000 metric: application_health page: 1 start: 1668121200 total_count: 1 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-interfaces: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedInterfaces description: For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type operationId: listSiteSleImpactedInterfaces parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_interfaces_scope_parameters' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_interfaces' - description: Paginated list of interfaces impacted by an SLE metric examples: - classifier: '' end: 1668760198 failure: '' interfaces: - degraded: 11.583333 duration: 765.4667 interface_name: ge-0/0/10 switch_mac: 2c2131001122 switch_name: test-ex total: 765.4667 - degraded: 191.08333 duration: 13775.35 interface_name: xe-0/1/0 switch_mac: 2c2131001122 switch_name: test-ex total: 13775.35 limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 5 contentMediaType: application/json examples: Example: value: classifier: '' end: 1668760198 failure: '' interfaces: - degraded: 11.583333 duration: 765.4667 interface_name: ge-0/0/10 switch_mac: 2c2131001122 switch_name: test-ex total: 765.4667 - degraded: 191.08333 duration: 13775.35 interface_name: xe-0/1/0 switch_mac: 2c2131001122 switch_name: test-ex total: 13775.35 limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 5 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_interfaces' - description: Paginated list of interfaces impacted by an SLE metric examples: - classifier: '' end: 1668760198 failure: '' interfaces: - degraded: 11.583333 duration: 765.4667 interface_name: ge-0/0/10 switch_mac: 2c2131001122 switch_name: test-ex total: 765.4667 - degraded: 191.08333 duration: 13775.35 interface_name: xe-0/1/0 switch_mac: 2c2131001122 switch_name: test-ex total: 13775.35 limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 5 contentMediaType: application/vnd.api+json examples: Example: value: classifier: '' end: 1668760198 failure: '' interfaces: - degraded: 11.583333 duration: 765.4667 interface_name: ge-0/0/10 switch_mac: 2c2131001122 switch_name: test-ex total: 765.4667 - degraded: 191.08333 duration: 13775.35 interface_name: xe-0/1/0 switch_mac: 2c2131001122 switch_name: test-ex total: 13775.35 limit: 1000 metric: switch_throughput page: 1 start: 1668726000 total_count: 5 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-switches: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedSwitches description: For Wired SLEs. List the impacted switches optionally filtered by classifier and failure type operationId: listSiteSleImpactedSwitches parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_switches_scope_parameters' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_switches' - description: Paginated list of switches impacted by an SLE metric examples: - classifier: '' end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 switches: - degraded: 109.88333 duration: 5753.75 interface: - ge-0/0/11 - xe-0/1/0 name: test-ex switch_mac: 2c2131001122 switch_model: EX2300-C-12P switch_version: 20.4R3-S3.4 total: 5753.75 total_count: 1 contentMediaType: application/json examples: Example: value: classifier: '' end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 switches: - degraded: 109.88333 duration: 5753.75 interface: - ge-0/0/11 - xe-0/1/0 name: test-ex switch_mac: 2c2131001122 switch_model: EX2300-C-12P switch_version: 20.4R3-S3.4 total: 5753.75 total_count: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_switches' - description: Paginated list of switches impacted by an SLE metric examples: - classifier: '' end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 switches: - degraded: 109.88333 duration: 5753.75 interface: - ge-0/0/11 - xe-0/1/0 name: test-ex switch_mac: 2c2131001122 switch_model: EX2300-C-12P switch_version: 20.4R3-S3.4 total: 5753.75 total_count: 1 contentMediaType: application/vnd.api+json examples: Example: value: classifier: '' end: 1668760198 failure: '' limit: 1000 metric: switch_throughput page: 1 start: 1668726000 switches: - degraded: 109.88333 duration: 5753.75 interface: - ge-0/0/11 - xe-0/1/0 name: test-ex switch_mac: 2c2131001122 switch_model: EX2300-C-12P switch_version: 20.4R3-S3.4 total: 5753.75 total_count: 1 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-users: parameters: [] get: tags: - Sites SLEs summary: listSiteSleImpactedWirelessClients description: For Wireless SLEs. List the impacted wireless users optionally filtered by classifier and failure type operationId: listSiteSleImpactedWirelessClients parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_impacted_users_scope_parameter' - name: scope_id in: path description: '' required: true schema: type: string contentEncoding: uuid - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: classifier in: query description: Filter SLE impact results by classifier style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_users' - description: Paginated list of users impacted by an SLE metric examples: - classifier: '' end: 1627313103 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226703 total_count: 21 users: - ap_mac: d420b0830000 ap_name: ap33.lab degraded: 2 device_os: '14.6' device_type: iPhone duration: 1270 mac: dc080f360000 name: aPhone-20973 ssid: lab.1X total: 1270 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 36 device_os: Android 11 device_type: OnePlus duration: 767 mac: 4c4feedc0000 name: OnePlus-8 ssid: lab.1X total: 767 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 2 device_os: Catalina device_type: Mac duration: 1405 mac: a483e7390000 name: tmunzer-mbp ssid: lab.1X total: 1405 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 81 device_os: Linux device_type: unknown duration: 1403 mac: 5caafd0d0000 name: SonosZP ssid: lab total: 1403 wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b contentMediaType: application/json examples: Example: value: classifier: '' end: 1627313103 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226703 total_count: 21 users: - ap_mac: d420b0830000 ap_name: ap33.lab degraded: 2 device_os: '14.6' device_type: iPhone duration: 1270 mac: dc080f360000 name: aPhone-20973 ssid: lab.1X total: 1270 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 36 device_os: Android 11 device_type: OnePlus duration: 767 mac: 4c4feedc0000 name: OnePlus-8 ssid: lab.1X total: 767 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 2 device_os: Catalina device_type: Mac duration: 1405 mac: a483e7390000 name: tmunzer-mbp ssid: lab.1X total: 1405 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 81 device_os: Linux device_type: unknown duration: 1403 mac: 5caafd0d0000 name: SonosZP ssid: lab total: 1403 wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_impacted_users' - description: Paginated list of users impacted by an SLE metric examples: - classifier: '' end: 1627313103 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226703 total_count: 21 users: - ap_mac: d420b0830000 ap_name: ap33.lab degraded: 2 device_os: '14.6' device_type: iPhone duration: 1270 mac: dc080f360000 name: aPhone-20973 ssid: lab.1X total: 1270 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 36 device_os: Android 11 device_type: OnePlus duration: 767 mac: 4c4feedc0000 name: OnePlus-8 ssid: lab.1X total: 767 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 2 device_os: Catalina device_type: Mac duration: 1405 mac: a483e7390000 name: tmunzer-mbp ssid: lab.1X total: 1405 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 81 device_os: Linux device_type: unknown duration: 1403 mac: 5caafd0d0000 name: SonosZP ssid: lab total: 1403 wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b contentMediaType: application/vnd.api+json examples: Example: value: classifier: '' end: 1627313103 failure: '' limit: 1000 metric: capacity page: 1 start: 1627226703 total_count: 21 users: - ap_mac: d420b0830000 ap_name: ap33.lab degraded: 2 device_os: '14.6' device_type: iPhone duration: 1270 mac: dc080f360000 name: aPhone-20973 ssid: lab.1X total: 1270 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 36 device_os: Android 11 device_type: OnePlus duration: 767 mac: 4c4feedc0000 name: OnePlus-8 ssid: lab.1X total: 767 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 2 device_os: Catalina device_type: Mac duration: 1405 mac: a483e7390000 name: tmunzer-mbp ssid: lab.1X total: 1405 wlan_id: a937da77-0000-0000-0000-f2134d7b1483 - ap_mac: 5c5b35500000 ap_name: ap43.lab degraded: 81 device_os: Linux device_type: unknown duration: 1403 mac: 5caafd0d0000 name: SonosZP ssid: lab total: 1403 wlan_id: 649a2336-0000-0000-0000-f637dbe50e7b '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/summary: parameters: [] get: tags: - Sites SLEs summary: getSiteSleSummary description: 'Get the summary for the SLE metric This API Endpoint is deprecated and replaced by Get Site SLE Summary Trend' operationId: getSiteSleSummary parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_metric_summary_scope_parameters' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_summary' - description: Deprecated SLE summary response for a metric window examples: - classifiers: - impact: num_aps: 1 num_users: 4 total_aps: 3 total_users: 26 interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 0 num_users: 0 total_aps: 3 total_users: 26 interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 1 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 events: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 contentMediaType: application/json examples: Example: value: classifiers: - impact: num_aps: 1 num_users: 4 total_aps: 3 total_users: 26 interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 0 num_users: 0 total_aps: 3 total_users: 26 interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 1 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 events: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_summary' - description: Deprecated SLE summary response for a metric window examples: - classifiers: - impact: num_aps: 1 num_users: 4 total_aps: 3 total_users: 26 interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 0 num_users: 0 total_aps: 3 total_users: 26 interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 1 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 events: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 contentMediaType: application/vnd.api+json examples: Example: value: classifiers: - impact: num_aps: 1 num_users: 4 total_aps: 3 total_users: 26 interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 2 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 0 num_users: 0 total_aps: 3 total_users: 26 interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - impact: num_aps: 1 num_users: 17 total_aps: 3 total_users: 26 interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 events: [] impact: num_aps: 2 num_users: 21 total_aps: 3 total_users: 26 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: true /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/summary-trend: parameters: [] get: tags: - Sites SLEs summary: getSiteSleSummaryTrend description: Get the summary for the SLE metric trend operationId: getSiteSleSummaryTrend parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_metric_summary_scope_parameters' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_summary_trend' - description: Time-series SLE summary trend response examples: - classifiers: - interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 contentMediaType: application/json examples: Example: value: classifiers: - interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_summary_trend' - description: Time-series SLE summary trend response examples: - classifiers: - interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 contentMediaType: application/vnd.api+json examples: Example: value: classifiers: - interval: 3600 name: client-count samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 0 - 0 - 0 - 4.65 - 0 - 7.55 - 47.55 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: wifi-interference samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 duration: - 0 - 0 - 210.03334 - 3.1333334 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 102.5 - 108.03333 - 0 - 0 - 201.9 - 566.48334 - 135.63333 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: client_usage samples: degraded: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes - interval: 3600 name: non-wifi-interference samples: degraded: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 duration: - 0 - 0 - 0 - 0 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 31.15 - 17.616667 - 17.85 - 0 - 0 - 0 - 0 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 x_label: seconds y_label: user-minutes end: 1627312606 sle: interval: 3600 name: capacity samples: degraded: - 0 - 0 - 210.03334 - 3.1333334 - 16.65 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 0 - 5.8 - 102.5 - 139.18333 - 17.616667 - 22.5 - 201.9 - 574.0333 - 183.18333 - 13.266666 total: - 1302.3 - 1289.0167 - 1396.3167 - 1423.6666 - 1439.2167 - 1414.7 - 1361.0834 - 1371.5834 - 1372.0667 - 1339.1 - 1374.3667 - 1369.9 - 1352.4833 - 1382.8 - 1426.7167 - 1425.6333 - 1403.9333 - 1420.75 - 1416.8334 - 1437.3334 - 1425.1 - 1485.3667 - 1426.4333 - 289.83334 value: - 0.6764934 - 0.6783766 - 0.641645 - 0.6934629 - 0.68676674 - 0.6834809 - 0.6961604 - 0.6979584 - 0.7033722 - 0.70410794 - 0.7025278 - 0.70305353 - 0.70292175 - 0.7009334 - 0.69344264 - 0.68596864 - 0.5952168 - 0.62183666 - 0.68161446 - 0.65352744 - 0.6183489 - 0.54178274 - 0.6044712 - 0.66845906 x_label: seconds y_label: '%' start: 1627226206 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/threshold: parameters: [] get: tags: - Sites SLEs summary: getSiteSleThreshold description: Get the SLE threshold operationId: getSiteSleThreshold parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_threshold_scope_parameter' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string examples: - asymmetry-uplink responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - description: Threshold metadata and configured value for an SLE metric examples: - default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm contentMediaType: application/json examples: Example: value: default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - description: Threshold metadata and configured value for an SLE metric examples: - default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm contentMediaType: application/vnd.api+json examples: Example: value: default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false post: tags: - Sites SLEs summary: replaceSiteSleThreshold description: Replace the SLE threshold operationId: replaceSiteSleThreshold parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_threshold_scope_parameter' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string examples: - asymmetry-uplink requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - examples: - maximum: -60 minimum: -90 contentMediaType: application/json examples: Example: value: maximum: -60 minimum: -90 required: false responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - description: Threshold metadata and configured value for an SLE metric examples: - default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm contentMediaType: application/json examples: Example: value: default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - description: Threshold metadata and configured value for an SLE metric examples: - default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm contentMediaType: application/vnd.api+json examples: Example: value: default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false put: tags: - Sites SLEs summary: updateSiteSleThreshold description: Update the SLE threshold operationId: updateSiteSleThreshold parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_threshold_scope_parameter' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: metric in: path description: Values from `listSiteSlesMetrics` required: true schema: type: string examples: - asymmetry-uplink requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - examples: - maximum: -60 minimum: -90 contentMediaType: application/json examples: Example: value: maximum: -60 minimum: -90 required: false responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - description: Threshold metadata and configured value for an SLE metric examples: - default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm contentMediaType: application/json examples: Example: value: default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/sle_threshold' - description: Threshold metadata and configured value for an SLE metric examples: - default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm contentMediaType: application/vnd.api+json examples: Example: value: default: -72 direction: left maximum: -60 metric: coverage minimum: -90 threshold: '-66' units: dBm '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics: parameters: [] get: tags: - Sites SLEs summary: listSiteSlesMetrics description: List the metrics for the given scope operationId: listSiteSlesMetrics parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: scope in: path description: '' required: true schema: $ref: '#/components/schemas/site_sle_metrics_scope_parameters' - name: scope_id in: path description: '* site_id if `scope`==`site` * device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway` * mac if `scope`==`client`' required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/site_sle_metrics' - description: SLE metrics available for a site examples: - enabled: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - throughput - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability supported: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - location_jitter - location_latency - throughput - location_dropped-requests - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability - location_sdk-connect-time - location_ble-hung contentMediaType: application/json examples: Example: value: enabled: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - throughput - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability supported: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - location_jitter - location_latency - throughput - location_dropped-requests - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability - location_sdk-connect-time - location_ble-hung application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/site_sle_metrics' - description: SLE metrics available for a site examples: - enabled: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - throughput - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability supported: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - location_jitter - location_latency - throughput - location_dropped-requests - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability - location_sdk-connect-time - location_ble-hung contentMediaType: application/vnd.api+json examples: Example: value: enabled: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - throughput - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability supported: - coverage - capacity - time-to-connect - failed-to-connect - roaming - roaming-v2 - location_jitter - location_latency - throughput - location_dropped-requests - switch_health - switch_throughput - switch_stc - gateway-health - application_health - wan-link-health - ap-availability - location_sdk-connect-time - location_ble-hung '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false components: schemas: sle_impact_summary_wlan_item: title: sle_impact_summary_wlan_item required: - degraded - duration - name - total - wlan_id type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this WLAN duration: type: number description: Observation time represented by this WLAN impact row name: minLength: 1 type: string description: Display name for the WLAN impact row total: type: number description: Overall SLE total measured for this WLAN impact row wlan_id: minLength: 1 type: string description: Identifier of the WLAN represented by this impact row description: SLE impact summary row for a WLAN sle_impacted_users: title: sle_impacted_users required: - classifier - end - failure - limit - metric - page - start - total_count type: object properties: classifier: type: string description: Requested SLE classifier filter applied to the query clients: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impacted_users_client' description: Impacted client rows returned for the SLE query end: type: number description: Last timestamp in the impacted users window failure: type: string description: Requested SLE failure filter applied to the query limit: type: integer description: Maximum number of impacted user rows returned per page contentEncoding: int32 metric: minLength: 1 type: string description: SLE metric name used for the impacted users query page: type: number description: Current page number for impacted user results start: type: number description: First timestamp in the impacted users window total_count: type: number description: Number of impacted user rows matching the query users: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impacted_users_user' description: Impacted user rows returned for the SLE query description: Paginated list of users impacted by an SLE metric response_http403: title: response_http403 type: object properties: detail: type: string description: Human-readable explanation of the permission error examples: - You do not have permission to perform this action. description: Standard HTTP 403 permission error response site_sle_impact_summary_fields_parameter: title: site_sle_impact_summary_fields_parameter enum: - ap - band - chassis - client - device_os - device_type - gateway - gateway_zones - interface - mxedge - peer_path - server - switch - vlan - wlan type: string description: 'enum: `ap`, `band`, `chassis`, `client`, `device_os`, `device_type`, `gateway`, `gateway_zones`, `interface`, `mxedge`, `peer_path`, `server`, `switch`, `vlan`, `wlan`' site_sle_impacted_gateways_scope_parameters: title: site_sle_impacted_gateways_scope_parameters const: site type: string description: 'Scope parameter value for impacted gateway SLE queries. enum: `site`' sle_classifier_samples3: title: sle_classifier_samples3 required: - degraded - duration - total type: object properties: degraded: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval degraded SLE values for the classifier duration: type: array items: type: number description: Per-interval observation durations for the classifier total: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval total SLE values for the classifier description: Time-series sample arrays for the classifier sle_summary_trend: title: sle_summary_trend required: - classifiers - end - sle - start type: object properties: classifiers: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_trend_classifier' description: SLE classifier trend details included in the response end: type: number description: Last timestamp in the SLE summary trend window sle: allOf: - $ref: '#/components/schemas/sle_summary_sle2' - description: Time-series SLE samples for the trend window start: type: number description: First timestamp in the SLE summary trend window description: Time-series SLE summary trend response sle_classifier1: title: sle_classifier1 required: - impact - interval - name - x_label - y_label type: object properties: impact: allOf: - $ref: '#/components/schemas/sle_classifier_impact2' - description: Counts of affected APs and users for this classifier interval: type: number description: Sample interval in seconds for classifier time-series data name: minLength: 1 type: string description: Classifier name for the SLE metric samples: allOf: - $ref: '#/components/schemas/sle_classifier_samples3' - description: Time-series sample arrays for the classifier x_label: minLength: 1 type: string description: Label for the classifier sample x-axis y_label: minLength: 1 type: string description: Label for the classifier sample y-axis description: Requested SLE classifier detail for the metric response_http400: title: response_http400 type: object properties: detail: type: string description: Human-readable explanation of the bad request error examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' description: Standard HTTP 400 bad request error response sle_threshold: title: sle_threshold type: object properties: default: type: number description: Built-in threshold value for this SLE metric readOnly: true direction: minLength: 1 type: string description: Comparison direction used for SLE threshold evaluation readOnly: true maximum: type: number description: Highest allowed threshold value for this SLE metric metric: minLength: 1 type: string description: SLE metric name associated with this threshold readOnly: true minimum: type: number description: Lowest allowed threshold value for this SLE metric threshold: minLength: 1 type: string description: Configured threshold value for this SLE metric readOnly: true units: minLength: 1 type: string description: Measurement units for this SLE threshold readOnly: true description: Threshold metadata and configured value for an SLE metric sle_impacted_interfaces_interface: title: sle_impacted_interfaces_interface type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this interface duration: type: number description: Observation time represented by this interface impact row interface_name: type: string description: Name of the switch interface represented by this impacted row switch_mac: type: string description: MAC address of the switch associated with this interface switch_name: type: string description: Display name of the switch associated with this interface total: type: number description: Overall SLE total measured for this interface impact row description: SLE impact row for a switch interface sle_impacted_applications_app: title: sle_impacted_applications_app type: object properties: app: type: string description: Identifier of the application represented by this impacted row degraded: type: integer description: Portion of the SLE total that was degraded for this application contentEncoding: int32 duration: type: integer description: Observation time represented by this application impact row contentEncoding: int32 name: type: string description: Display name for the application impact row threshold: type: integer description: SLE threshold value used for this application contentEncoding: int32 total: type: integer description: Overall SLE total measured for this application impact row contentEncoding: int32 description: SLE impact row for an application sle_impacted_users_user: title: sle_impacted_users_user type: object properties: ap_mac: type: string description: MAC address of the AP associated with this impacted user ap_name: type: string description: Display name of the AP associated with this impacted user degraded: type: number description: Portion of the SLE total that was degraded for this user device_os: type: string description: Client device OS for this impacted user device_type: type: string description: Client device type for this impacted user duration: type: number description: Observation time represented by this user impact row mac: type: string description: Client MAC address for this impacted user name: type: string description: Display name for the user impact row ssid: type: string description: Wireless network SSID used by this impacted user total: type: number description: Overall SLE total measured for this user impact row wlan_id: type: string description: Identifier of the WLAN used by this impacted user description: SLE impact row for a user sle_impacted_clients: title: sle_impacted_clients type: object properties: classifier: type: string description: Requested SLE classifier filter applied to the query clients: type: array items: $ref: '#/components/schemas/sle_impacted_clients_client' description: Impacted client rows returned for the SLE query end: type: integer description: Last timestamp in the impacted clients window contentEncoding: int32 failure: type: string description: Requested SLE failure filter applied to the query limit: type: integer description: Maximum number of impacted client rows returned per page contentEncoding: int32 metric: type: string description: SLE metric name used for the impacted clients query page: type: integer description: Current page number for impacted client results contentEncoding: int32 start: type: integer description: First timestamp in the impacted clients window contentEncoding: int32 total_count: type: integer description: Number of impacted client rows matching the query contentEncoding: int32 description: Paginated list of clients impacted by an SLE metric site_sle_threshold_scope_parameter: title: site_sle_threshold_scope_parameter enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_summary_scope: title: sle_summary_scope enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_histogram: title: sle_histogram required: - data - end - metric - start - x_label - y_label type: object properties: data: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_histogram_data_item' description: Histogram buckets for the SLE metric end: type: number description: Last timestamp in the histogram window metric: minLength: 1 type: string description: SLE metric name represented by the histogram start: type: number description: First timestamp in the histogram window x_label: minLength: 1 type: string description: Label for the histogram x-axis y_label: minLength: 1 type: string description: Label for the histogram y-axis description: Histogram response for an SLE metric response_http401: title: response_http401 type: object properties: detail: type: string description: Human-readable explanation of the authentication error examples: - Authentication credentials were not provided. description: Standard HTTP 401 authentication error response site_sle_histogram_scope_parameters: title: site_sle_histogram_scope_parameters enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_impacted_chassis: title: sle_impacted_chassis type: object properties: chassis: type: array items: $ref: '#/components/schemas/sle_impacted_chassis_chassis_item' description: Impacted chassis rows returned for the SLE query classifier: type: string description: Requested SLE classifier filter applied to the query end: type: integer description: Last timestamp in the impacted chassis window contentEncoding: int32 failure: type: string description: Requested SLE failure filter applied to the query limit: type: integer description: Maximum number of impacted chassis rows returned per page contentEncoding: int32 metric: type: string description: SLE metric name used for the impacted chassis query page: type: integer description: Current page number for impacted chassis results contentEncoding: int32 start: type: integer description: First timestamp in the impacted chassis window contentEncoding: int32 total_count: type: integer description: Number of impacted chassis rows matching the query contentEncoding: int32 description: Paginated list of chassis impacted by an SLE metric sle_impact_summary_device_os_item: title: sle_impact_summary_device_os_item required: - degraded - device_os - duration - name - total type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this device OS device_os: type: string description: Client device OS represented by this impact row duration: type: number description: Observation time represented by this device-OS impact row name: minLength: 1 type: string description: Display name for the device-OS impact row total: type: number description: Overall SLE total measured for this device-OS impact row description: SLE impact summary row for a client device OS sle_classifier_summary: title: sle_classifier_summary required: - classifier - end - failures - impact - metric - start type: object properties: classifier: allOf: - $ref: '#/components/schemas/sle_classifier1' - description: Requested SLE classifier detail for the metric end: type: number description: Last timestamp in the classifier summary window failures: type: array items: type: object description: Failure records included in the classifier summary impact: allOf: - $ref: '#/components/schemas/sle_classifier_summary_impact2' - description: AP and user impact counts for the classifier summary window metric: minLength: 1 type: string description: SLE metric name summarized by this response start: type: number description: First timestamp in the classifier summary window description: Deprecated SLE classifier summary response deprecated: true sle_impacted_aps_ap: title: sle_impacted_aps_ap required: - ap_mac - degraded - duration - name - total type: object properties: ap_mac: minLength: 1 type: string description: MAC address of the AP represented by this impacted row degraded: type: number description: Portion of the SLE total that was degraded for this AP duration: type: number description: Observation time represented by this AP impact row name: minLength: 1 type: string description: Display name for the AP impact row total: type: number description: Overall SLE total measured for this AP impact row description: SLE impact row for an AP site_sle_metrics_scope_parameters: title: site_sle_metrics_scope_parameters enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_impacted_applications: title: sle_impacted_applications type: object properties: apps: type: array items: $ref: '#/components/schemas/sle_impacted_applications_app' description: Impacted application rows returned for the SLE query classifier: type: string description: Requested SLE classifier filter applied to the query end: type: integer description: Last timestamp in the impacted applications window contentEncoding: int32 failure: type: string description: Requested SLE failure filter applied to the query limit: type: integer description: Maximum number of impacted application rows returned per page contentEncoding: int32 metric: type: string description: SLE metric name used for the impacted applications query page: type: integer description: Current page number for impacted application results contentEncoding: int32 start: type: integer description: First timestamp in the impacted applications window contentEncoding: int32 total_count: type: integer description: Number of impacted application rows matching the query contentEncoding: int32 description: Paginated list of applications impacted by an SLE metric sle_impacted_clients_client_switch: title: sle_impacted_clients_client_switch type: object properties: interfaces: uniqueItems: true type: array items: type: string description: Switch interfaces associated with this impacted client switch_mac: type: string description: MAC address of the switch associated with this impacted client switch_name: type: string description: Display name of the switch associated with this impacted client description: Switch association for an impacted client sle_classifier_samples2: title: sle_classifier_samples2 required: - degraded - duration - total type: object properties: degraded: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval degraded SLE values for the classifier duration: type: array items: type: number description: Per-interval observation durations for the classifier total: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval total SLE values for the classifier description: Time-series sample arrays for the classifier trend site_sle_impact_summary_scope_parameters: title: site_sle_impact_summary_scope_parameters enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_classifier: title: sle_classifier required: - impact - interval - name - x_label - y_label type: object properties: impact: allOf: - $ref: '#/components/schemas/sle_classifier_impact2' - description: Counts of affected APs and users for this classifier interval: type: number description: Sample interval in seconds for classifier time-series data name: minLength: 1 type: string description: Classifier name for the SLE metric samples: allOf: - $ref: '#/components/schemas/sle_classifier_samples3' - description: Time-series sample arrays for the classifier x_label: minLength: 1 type: string description: Label for the classifier sample x-axis y_label: minLength: 1 type: string description: Label for the classifier sample y-axis description: Time-series classifier detail for an SLE metric site_sle_scope: title: site_sle_scope enum: - gateway - site - switch type: string description: 'enum: `gateway`, `site`, `switch`' sle_summary_sle3: title: sle_summary_sle3 required: - interval - name - samples - x_label - y_label type: object properties: interval: type: number description: Sample interval in seconds for SLE summary data name: minLength: 1 type: string description: SLE metric name represented by the summary samples samples: allOf: - $ref: '#/components/schemas/sle_summary_sle_samples2' - description: Per-interval sample arrays for the SLE metric x_label: minLength: 1 type: string description: Label for the SLE summary x-axis y_label: minLength: 1 type: string description: Label for the SLE summary y-axis description: Time-series SLE samples for the summary window site_sle_impacted_interfaces_scope_parameters: title: site_sle_impacted_interfaces_scope_parameters enum: - gateway - site - switch type: string description: 'enum: `gateway`, `site`, `switch`' sle_impacted_client_gateway: title: sle_impacted_client_gateway type: object properties: chassis_mac: type: string description: MAC address of the chassis associated with this client gateway row gateway_mac: type: string description: MAC address of the gateway associated with this client row gateway_name: type: string description: Display name of the gateway associated with this client row interfaces: uniqueItems: true type: array items: type: string description: Network interfaces associated with this client gateway row description: Gateway association for an impacted client site_sle_impacted_clients_scope_parameters: title: site_sle_impacted_clients_scope_parameters enum: - gateway - site - switch type: string description: 'enum: `gateway`, `site`, `switch`' sle_impacted_switches_switch: title: sle_impacted_switches_switch type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this switch duration: type: number description: Observation time represented by this switch impact row interface: uniqueItems: true type: array items: type: string description: Switch interfaces contributing to this impacted switch row name: type: string description: Display name for the switch impact row switch_mac: type: string description: MAC address of the switch represented by this impacted row switch_model: type: string description: Model of the switch represented by this impacted row switch_version: type: string description: Firmware version of the switch represented by this impacted row total: type: number description: Overall SLE total measured for this switch impact row description: SLE impact row for a switch site_sle_metric_summary_scope_parameters: title: site_sle_metric_summary_scope_parameters enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_impact_summary_device_type_item: title: sle_impact_summary_device_type_item required: - degraded - device_type - duration - name - total type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this device type device_type: type: string description: Client device type represented by this impact row duration: type: number description: Observation time represented by this device-type impact row name: minLength: 1 type: string description: Display name for the device-type impact row total: type: number description: Overall SLE total measured for this device-type impact row description: SLE impact summary row for a client device type sle_impacted_chassis_chassis_item: title: sle_impacted_chassis_chassis_item type: object properties: chassis: type: string description: Identifier of the chassis represented by this impacted row degraded: type: number description: Portion of the SLE total that was degraded for this chassis duration: type: number description: Observation time represented by this chassis impact row role: type: string description: Virtual Chassis role for the switch member switch_mac: type: string description: MAC address of the switch represented by this chassis row switch_name: type: string description: Display name of the switch represented by this chassis row total: type: number description: Overall SLE total measured for this chassis impact row description: SLE impact row for a chassis sle_impact_summary_ap_item: title: sle_impact_summary_ap_item required: - ap_mac - degraded - duration - name - total type: object properties: ap_mac: minLength: 1 type: string description: MAC address of the AP represented by this impact row degraded: type: number description: Portion of the SLE total that was degraded for this AP duration: type: number description: Observation time represented by this AP impact row name: minLength: 1 type: string description: Display name for the AP impact row total: type: number description: Overall SLE total measured for this AP impact row description: SLE impact summary row for an AP sle_impacted_clients_client: title: sle_impacted_clients_client type: object properties: degraded: type: integer description: Portion of the SLE total that was degraded for this client contentEncoding: int32 duration: type: integer description: Observation time represented by this client impact row contentEncoding: int32 mac: type: string description: Client MAC address for the impacted client name: type: string description: Display name for the client impact row switches: type: array items: $ref: '#/components/schemas/sle_impacted_clients_client_switch' description: Switch rows associated with the impacted client total: type: integer description: Overall SLE total measured for this client impact row contentEncoding: int32 description: SLE impact row for a client site_sle_impacted_switches_scope_parameters: title: site_sle_impacted_switches_scope_parameters const: site type: string description: 'Scope parameter value for impacted switch SLE queries. enum: `site`' sle_classifier_impact2: title: sle_classifier_impact2 required: - num_aps - num_users - total_aps - total_users type: object properties: num_aps: type: number description: Number of APs affected by degraded SLE experience num_users: type: number description: Number of users affected by degraded SLE experience total_aps: type: number description: Total number of APs considered for the classifier total_users: type: number description: Total number of users considered for the classifier description: Counts of affected APs and users for this classifier site_sle_metric_classifiers_scope_parameters: title: site_sle_metric_classifiers_scope_parameters enum: - ap - client - gateway - site - switch type: string description: 'enum: `ap`, `client`, `gateway`, `site`, `switch`' sle_trend_classifier: title: sle_trend_classifier required: - interval - name - x_label - y_label type: object properties: interval: type: number description: Sample interval in seconds for classifier trend data name: minLength: 1 type: string description: Classifier name for the SLE metric trend samples: allOf: - $ref: '#/components/schemas/sle_classifier_samples2' - description: Time-series sample arrays for the classifier trend x_label: minLength: 1 type: string description: Label for the classifier trend x-axis y_label: minLength: 1 type: string description: Label for the classifier trend y-axis description: Time-series classifier trend detail for an SLE metric sle_classifier_summary_trend: title: sle_classifier_summary_trend required: - classifier - end - metric - start type: object properties: classifier: allOf: - $ref: '#/components/schemas/sle_trend_classifier2' - description: Requested SLE classifier trend detail for the metric end: type: number description: Last timestamp in the classifier trend window metric: minLength: 1 type: string description: SLE metric name represented by the trend start: type: number description: First timestamp in the classifier trend window description: Time-series trend response for an SLE classifier sle_impacted_switches: title: sle_impacted_switches type: object properties: classifier: type: string description: Requested SLE classifier filter applied to the query end: type: integer description: Last timestamp in the impacted switches window contentEncoding: int32 failure: type: string description: Requested SLE failure filter applied to the query limit: type: integer description: Maximum number of impacted switch rows returned per page contentEncoding: int32 metric: type: string description: SLE metric name used for the impacted switches query page: type: integer description: Current page number for impacted switch results contentEncoding: int32 start: type: integer description: First timestamp in the impacted switches window contentEncoding: int32 switches: type: array items: $ref: '#/components/schemas/sle_impacted_switches_switch' description: Impacted switch rows returned for the SLE query total_count: type: integer description: Number of impacted switch rows matching the query contentEncoding: int32 description: Paginated list of switches impacted by an SLE metric sle_impact_summary: title: sle_impact_summary required: - ap - band - classifier - device_os - device_type - end - failure - metric - start - wlan type: object properties: ap: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impact_summary_ap_item' description: Impact rows grouped by AP band: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impact_summary_band_item' description: Impact rows grouped by radio band classifier: type: string description: Requested SLE classifier filter applied to the impact summary device_os: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impact_summary_device_os_item' description: Impact rows grouped by client device OS device_type: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impact_summary_device_type_item' description: Impact rows grouped by client device type end: type: number description: Last timestamp in the impact summary window failure: type: string description: Requested SLE failure filter applied to the impact summary metric: minLength: 1 type: string description: SLE metric name summarized by this response start: type: number description: First timestamp in the impact summary window wlan: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impact_summary_wlan_item' description: Impact rows grouped by WLAN description: SLE impact summary grouped by client, device, AP, WLAN, and band dimensions sle_impacted_gateways_gateway: title: sle_impacted_gateways_gateway type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this gateway duration: type: integer description: Observation time represented by this gateway impact row contentEncoding: int32 gateway_mac: type: string description: MAC address of the gateway represented by this impacted row gateway_model: type: string description: Model of the gateway represented by this impacted row gateway_version: type: string description: Firmware version of the gateway represented by this impacted row name: type: string description: Display name for the gateway impact row total: type: integer description: Overall SLE total measured for this gateway impact row contentEncoding: int32 description: SLE impact row for a gateway sle_impacted_aps: title: sle_impacted_aps required: - aps - classifier - end - failure - limit - metric - page - start - total_count type: object properties: aps: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_impacted_aps_ap' description: Impacted access point rows returned for the SLE query classifier: type: string description: Requested SLE classifier filter applied to the query end: type: number description: Last timestamp in the impacted APs window failure: type: string description: Requested SLE failure filter applied to the query limit: type: integer description: Maximum number of impacted AP rows returned per page contentEncoding: int32 metric: minLength: 1 type: string description: SLE metric name used for the impacted APs query page: type: number description: Current page number for impacted AP results start: type: number description: First timestamp in the impacted APs window total_count: type: number description: Number of impacted AP rows matching the query description: Paginated list of APs impacted by an SLE metric number_or_null: oneOf: - type: number description: Numeric value or null site_sle_impacted_aps_scope_parameters: title: site_sle_impacted_aps_scope_parameters const: site type: string description: 'Scope parameter value for impacted AP SLE queries. enum: `site`' site_sle_metrics: title: site_sle_metrics required: - enabled - supported type: object properties: enabled: uniqueItems: true type: array items: type: string description: SLE metric names enabled for the site supported: uniqueItems: true type: array items: type: string description: SLE metric names supported for the site description: SLE metrics available for a site sle_impacted_gateways: title: sle_impacted_gateways type: object properties: classifier: type: string description: Requested SLE classifier filter applied to the query end: type: integer description: Last timestamp in the impacted gateways window contentEncoding: int32 failure: type: string description: Requested SLE failure filter applied to the query gateways: type: array items: $ref: '#/components/schemas/sle_impacted_gateways_gateway' description: Impacted gateway rows returned for the SLE query limit: type: integer description: Maximum number of impacted gateway rows returned per page contentEncoding: int32 metric: type: string description: SLE metric name used for the impacted gateways query page: type: integer description: Current page number for impacted gateway results contentEncoding: int32 start: type: integer description: First timestamp in the impacted gateways window contentEncoding: int32 total_count: type: integer description: Number of impacted gateway rows matching the query contentEncoding: int32 description: Paginated list of gateways impacted by an SLE metric site_sle_impacted_chassis_scope_parameters: title: site_sle_impacted_chassis_scope_parameters enum: - gateway - site - switch type: string description: 'enum: `gateway`, `site`, `switch`' sle_summary_sle_samples2: title: sle_summary_sle_samples2 required: - degraded - total - value type: object properties: degraded: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval degraded SLE values for the summary total: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval total SLE values for the summary value: type: array items: $ref: '#/components/schemas/number_or_null' description: Per-interval SLE score values for the summary description: Per-interval sample arrays for the SLE metric sle_impacted_users_client: title: sle_impacted_users_client type: object properties: degraded: type: number description: Portion of the SLE total that was degraded for this client duration: type: number description: Observation time represented by this client impact row gateways: type: array items: $ref: '#/components/schemas/sle_impacted_client_gateway' description: Gateway rows associated with the impacted client mac: type: string description: Client MAC address for the impacted client name: type: string description: Display name for the client impact row src_ip: type: string description: Client source IP address for the impacted client total: type: number description: Overall SLE total measured for this client impact row description: SLE impact row for a client in an impacted users response site_sle_impacted_users_scope_parameter: title: site_sle_impacted_users_scope_parameter enum: - ap - site type: string description: 'Scope parameter value for impacted user SLE queries. enum: `ap`, `site`' sle_impacted_interfaces: title: sle_impacted_interfaces type: object properties: classifier: type: string description: Requested SLE classifier filter applied to the query end: type: integer description: Last timestamp in the impacted interfaces window contentEncoding: int32 failure: type: string description: Requested SLE failure filter applied to the query interfaces: type: array items: $ref: '#/components/schemas/sle_impacted_interfaces_interface' description: Impacted interface rows returned for the SLE query limit: type: integer description: Maximum number of impacted interface rows returned per page contentEncoding: int32 metric: type: string description: SLE metric name used for the impacted interfaces query page: type: integer description: Current page number for impacted interface results contentEncoding: int32 start: type: integer description: First timestamp in the impacted interfaces window contentEncoding: int32 total_count: type: integer description: Number of impacted interface rows matching the query contentEncoding: int32 description: Paginated list of interfaces impacted by an SLE metric response_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response sle_summary_impact2: title: sle_summary_impact2 required: - num_aps - num_users - total_aps - total_users type: object properties: num_aps: type: number description: Number of APs affected by degraded SLE experience num_users: type: number description: Number of users affected by degraded SLE experience total_aps: type: number description: Total number of APs considered in the summary window total_users: type: number description: Total number of users considered in the summary window description: AP and user impact counts for the summary window sle_trend_classifier2: title: sle_trend_classifier2 required: - interval - name - x_label - y_label type: object properties: interval: type: number description: Sample interval in seconds for classifier trend data name: minLength: 1 type: string description: Classifier name for the SLE metric trend samples: allOf: - $ref: '#/components/schemas/sle_classifier_samples2' - description: Time-series sample arrays for the classifier trend x_label: minLength: 1 type: string description: Label for the classifier trend x-axis y_label: minLength: 1 type: string description: Label for the classifier trend y-axis description: Requested SLE classifier trend detail for the metric sle_histogram_data_item: title: sle_histogram_data_item required: - value type: object properties: range: type: array items: type: - number - 'null' description: Boundary values for this histogram bucket value: type: number description: Measured amount for this histogram bucket description: Single bucket in an SLE histogram response_http429: title: response_http429 type: object properties: detail: type: string description: Human-readable explanation of the rate limit error examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold description: Standard HTTP 429 rate limit error response sle_summary: title: sle_summary required: - classifiers - end - events - impact - sle - start type: object properties: classifiers: uniqueItems: true type: array items: $ref: '#/components/schemas/sle_classifier' description: SLE classifier details included in the summary end: type: number description: Last timestamp in the SLE summary window events: type: array items: type: object description: Event records included in the SLE summary impact: allOf: - $ref: '#/components/schemas/sle_summary_impact2' - description: AP and user impact counts for the summary window sle: allOf: - $ref: '#/components/schemas/sle_summary_sle3' - description: Time-series SLE samples for the summary window start: type: number description: First timestamp in the SLE summary window description: Deprecated SLE summary response for a metric window deprecated: true sle_impact_summary_band_item: title: sle_impact_summary_band_item required: - band - degraded - duration - name - total type: object properties: band: minLength: 1 type: string description: Radio band represented by this impact row degraded: type: number description: Portion of the SLE total that was degraded for this radio band duration: type: number description: Observation time represented by this radio-band impact row name: minLength: 1 type: string description: Display name for the radio-band impact row total: type: number description: Overall SLE total measured for this radio-band impact row description: SLE impact summary row for a radio band sle_classifier_summary_impact2: title: sle_classifier_summary_impact2 required: - num_aps - num_users - total_aps - total_users type: object properties: num_aps: type: number description: Number of APs affected by degraded SLE experience num_users: type: number description: Number of users affected by degraded SLE experience total_aps: type: number description: Total number of APs considered in the summary window total_users: type: number description: Total number of users considered in the summary window description: AP and user impact counts for the classifier summary window sle_summary_sle2: title: sle_summary_sle2 required: - interval - name - samples - x_label - y_label type: object properties: interval: type: number description: Sample interval in seconds for SLE summary data name: minLength: 1 type: string description: SLE metric name represented by the summary samples samples: allOf: - $ref: '#/components/schemas/sle_summary_sle_samples2' - description: Per-interval sample arrays for the SLE metric x_label: minLength: 1 type: string description: Label for the SLE summary x-axis y_label: minLength: 1 type: string description: Label for the SLE summary y-axis description: Time-series SLE samples for the trend window securitySchemes: apiToken: type: apiKey description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed." name: Authorization in: header csrfToken: type: apiKey description: 'Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session. **Format**: ``` X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx ``` For automation, API Token authentication is preferred.' name: X-CSRFToken in: header