openapi: 3.2.0
info:
title: Open API Spec for Assurance Transit Networks Transit Network Health Summaries API
description: "### OpenAPI specification defined for the purpose of providing visibility into the Transit Networks and their health in Catalyst Center\n**Relevant Concepts**\n| Term | Description |\n| -- | -- |\n| `Transit Network` | A fabric transit site is a special type of fabric site that connects multiple other fabric sites within a single fabric domain. The health aspect of this category applies only to SD-Access transit networks because health status is only monitored for these sites, not for IP transit sites|\n| `Fabric Site` | A fabric site is a logical subdivision of a larger network fabric, containing its own control plane nodes for management, border nodes for routing traffic between sites, and edge nodes that connect devices to the fabric. |\n| `Fabric deployments` | There are 2 types of Fabric deployments, namely 'LISP' and 'EVPN'.| \n| `LISP-based deployments` | LISP based deployments accommodate the following fabric entities: 'Fabric sites', 'Virtual networks (L2/L3)', and 'Transit Networks'. L2 VN health is not applicable for LISP based deployments.|\n| `EVPN-based deployments` | EVPN based deployments support 'Fabric sites' and 'Virtual networks (L2/L3)' currently. Transit networks is not applicable for EVPN based deployments.| \n| `Overall Transit Network Health` | The health status of the fabric is determined by examining the session status of Transit Networks. A valid Health score for Transit Networks ranges from 0-100 and is categorized as follows: Good (80-100), Fair (40-80), Poor (0-40), and No Health (--).|\n| `Transit Control Plane Health` | Health of the Transit control plane status. Health score ranges from 0 to 100.|\n| `Transit Services Health` | Health of the Transit services. Health score ranges from 0 to 100.|\n**API Support Documentation**\n\n**Views**\n\nSpecified 'views' can be requested for non-count APIs. Each view corresponds to different sets of data. \n\n'views' an optional parameter which can be passed to get one or more of the specific health data summaries associated with transit networks.\n\n'views' is also an optional field in the post request bodies.\n\n| View | Response Data |\n| --- | --- |\n| `transitInfo` | id, name, siteHierarchy, siteHierarchyId, controlPlaneCount, transitType, fabricSitesCount | \n| `overallHealth` | id, name, goodHealthPercentage, goodHealthDeviceCount, totalDeviceCount, poorHealthDeviceCount, fairHealthDeviceCount,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount,transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount | \n| `transitControlPlaneHealth` | id, name,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount,transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, pubsubTransitHealthPercentage, pubsubTransitTotalDeviceCount, pubsubTransitGoodHealthDeviceCount, pubsubTransitPoorHealthDeviceCount, pubsubTransitFairHealthDeviceCount, lispTransitHealthPercentage, lispTransitTotalDeviceCount, lispTransitGoodHealthDeviceCount, lispTransitPoorHealthDeviceCount, lispTransitFairHealthDeviceCount, bgpTcpHealthPercentage, bgpTcpTotalDeviceCount, bgpTcpGoodHealthDeviceCount, bgpTcpPoorHealthDeviceCount, bgpTcpFairHealthDeviceCount | \n \n| `transitServicesHealth` | id, name, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount, internetAvailTransitHealthPercentage, internetAvailTransitTotalDeviceCount, internetAvailTransitGoodHealthDeviceCount,internetAvailTransitPoorHealthDeviceCount, internetAvailTransitFairHealthDeviceCount | \n\n\n When this query parameter is not added the default summaries are: \n\n [`transitInfo`, `health`]\n\n **Examples**:\n\n view=overallHealth (single view requested)\n\n view=transitInfo&view=overallHealth (multiple views requested)\n \n### **Attributes** ###\n\nSpecified 'attributes' can be requested for non-count APIs. Each attribute requested will be part of the API response.\n\n**Supported Attributes:**\n\n1.`id`,`name`,`siteHierarchy`,`siteHierarchyId`, `controlPlaneCount`, `transitType`, `fabricSitesCount`, `goodHealthPercentage`, `goodHealthDeviceCount`, `totalDeviceCount`,`poorHealthDeviceCount`, `fairHealthDeviceCount`,`transitControlPlaneHealthPercentage`, `transitControlPlaneTotalDeviceCount`, `transitControlPlaneGoodHealthDeviceCount`, `transitControlPlanePoorHealthDeviceCount`, `transitControlPlaneFairHealthDeviceCount`, `transitServicesHealthPercentage`, `transitServicesTotalDeviceCount`, `transitServicesGoodHealthDeviceCount`,`transitServicesPoorHealthDeviceCount`, `transitServicesFairHealthDeviceCount`, `pubsubTransitHealthPercentage`, `pubsubTransitTotalDeviceCount`, `pubsubTransitGoodHealthDeviceCount`, `pubsubTransitPoorHealthDeviceCount`, `pubsubTransitFairHealthDeviceCount`, `lispTransitHealthPercentage`, `lispTransitTotalDeviceCount`, `lispTransitGoodHealthDeviceCount`,`lispTransitPoorHealthDeviceCount`, `lispTransitFairHealthDeviceCount`, `internetAvailTransitHealthPercentage`, `internetAvailTransitTotalDeviceCount`,`internetAvailTransitGoodHealthDeviceCount`,`internetAvailTransitPoorHealthDeviceCount`,`internetAvailTransitFairHealthDeviceCount`, `bgpTcpHealthPercentage`,`bgpTcpTotalDeviceCount`, `bgpTcpGoodHealthDeviceCount`, `bgpTcpPoorHealthDeviceCount`, `bgpTcpFairHealthDeviceCount`\nIf length of attribute list is too long, when using the query parameter for GET requests, please use `view` param instead.\n\n Examples:\n \n 1. query param:\n \n ?attribute=totalDeviceCount (single attribute requested)\n \n ?attribute=totalDeviceCount&attribute=goodHealthPercentage (multiple attributes requested)\n \n 2. post body:\n \n attributes=[\"totalDeviceCount\",\"goodHealthPercentage\"] "
termsOfService: https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html
contact:
name: Cisco TAC World Wide
url: https://www.cisco.com/c/en/us/support/web/tsd-cisco-worldwide-contacts.html
email: tac@cisco.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.1
x-provenance:
method: harvested
authored_by: Cisco Catalyst Center
harvested_by: API Evangelist
harvested_on: '2026-08-19'
first_party: true
provider_published: true
source_host: developer.cisco.com
note: 27 Cisco-published OpenAPI 3.0 Assurance documents (185 operations). Ownership confirmed from the tac@cisco.com contact, the Cisco EULA terms-of-service URL and the Cisco Catalyst Center license block carried in each document.
x-evidence:
- type: source
url: https://developer.cisco.com/docs/catalyst-center/
- type: source
url: https://developer.cisco.com/dnacenter/
servers:
- url: https://developer.cisco.com/data/api/v1
tags:
- name: transitNetworkHealthSummaries
paths:
/transitNetworkHealthSummaries:
get:
tags:
- transitNetworkHealthSummaries
summary: Read list of Transit Networks with their health summary
description: 'Get a paginated list of Transit Networks with health summary.
This API provides the latest health data from a given `endTime`
If data is not ready for the provided endTime, the request will fail, and the error message will indicate the recommended endTime to use to retrieve a complete data set.
This behavior may occur if the provided endTime=currentTime, since we are not a real time system.
When `endTime` is not provided, the API returns the latest data.'
operationId: readTransitNetworksSummary
parameters:
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: limit
in: query
description: Maximum number of records to return
schema:
maximum: 100
minimum: 1
type: integer
default: 100
- name: offset
in: query
description: Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.
schema:
minimum: 1
type: integer
default: 1
- name: sortBy
in: query
description: A field within the response to sort by.
schema:
type: string
- name: order
in: query
description: The sort order of the field ascending or descending.
schema:
type: string
default: asc
enum:
- asc
- desc
- name: id
in: query
description: 'The list of entity Uuids. (Ex."6bef213c-19ca-4170-8375-b694e251101c")
Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested)
id=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with ''&'' separator)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: attribute
in: query
description: 'Supported Attributes:
[id,name,siteHierarchy,siteHierarchyId, controlPlaneCount, transitType, fabricSitesCount, goodHealthPercentage, goodHealthDeviceCount, totalDeviceCount,poorHealthDeviceCount, fairHealthDeviceCount,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount, transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount, pubsubTransitHealthPercentage, pubsubTransitTotalDeviceCount, pubsubTransitGoodHealthDeviceCount, pubsubTransitPoorHealthDeviceCount, pubsubTransitFairHealthDeviceCount, lispTransitHealthPercentage, lispTransitTotalDeviceCount, lispTransitGoodHealthDeviceCount,lispTransitPoorHealthDeviceCount, lispTransitFairHealthDeviceCount, internetAvailTransitHealthPercentage, internetAvailTransitTotalDeviceCount,internetAvailTransitGoodHealthDeviceCount,internetAvailTransitPoorHealthDeviceCount,internetAvailTransitFairHealthDeviceCount, bgpTcpHealthPercentage,bgpTcpTotalDeviceCount, bgpTcpGoodHealthDeviceCount, bgpTcpPoorHealthDeviceCount, bgpTcpFairHealthDeviceCount]
Examples:
attribute=GoodHealthPercentage (single attribute requested)
attribute=GoodHealthPercentage&attribute=pubsubTransitFairHealthDeviceCount (multiple attributes requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: view
in: query
description: "The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific health data summaries associated with sites.\n\n### Response data proviced by each view: \n\n1. **transitInfo**\n[id, name, siteHierarchy, siteHierarchyId, controlPlaneCount, transitType, fabricSitesCount] \n\n2. **overallHealth**\n[id, name, goodHealthPercentage, goodHealthDeviceCount, totalDeviceCount, poorHealthDeviceCount, fairHealthDeviceCount,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount,transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount ] \n\n3. **transitControlPlaneHealth**\n[id, name,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount,transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, pubsubTransitHealthPercentage, pubsubTransitTotalDeviceCount, pubsubTransitGoodHealthDeviceCount, pubsubTransitPoorHealthDeviceCount, pubsubTransitFairHealthDeviceCount, lispTransitHealthPercentage, lispTransitTotalDeviceCount, lispTransitGoodHealthDeviceCount, lispTransitPoorHealthDeviceCount, lispTransitFairHealthDeviceCount, bgpTcpHealthPercentage, bgpTcpTotalDeviceCount, bgpTcpGoodHealthDeviceCount, bgpTcpPoorHealthDeviceCount, bgpTcpFairHealthDeviceCount] \n\n4. **transitServicesHealth**\n[id, name, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount, internetAvailTransitHealthPercentage, internetAvailTransitTotalDeviceCount, internetAvailTransitGoodHealthDeviceCount,internetAvailTransitPoorHealthDeviceCount, internetAvailTransitFairHealthDeviceCount] \n\nWhen this query parameter is not added the default summaries are: \n\n**[transitInfo, overallHealth]**\n\nExamples:\n\nview=overallHealth (single view requested)\n\nview=transitInfo&view=overallHealth (multiple views requested)\n"
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: transit networks summmary response covering all transit networks and their health.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/TransitNetworksSummaries'
examples:
Response1:
$ref: '#/components/examples/TransitNetworksResponseExample1'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/transitNetworkHealthSummaries/{id}:
get:
tags:
- transitNetworkHealthSummaries
summary: Read list of transit networks with their health summary
description: 'Get health summary for a specific transit Network by providing the unique transit networks id in the url path.
This API provides the latest health data from a given `endTime`
If data is not ready for the provided endTime, the request will fail, and the error message will indicate the recommended endTime to use to retrieve a complete data set.
This behavior may occur if the provided endTime=currentTime, since we are not a real time system.
When `endTime` is not provided, the API returns the latest data.'
operationId: transitNetworkSummaryById
parameters:
- name: id
in: path
description: unique transit networks id
required: true
style: simple
explode: false
schema:
type: string
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: attribute
in: query
description: 'Supported Attributes:
[id,name,siteHierarchy,siteHierarchyId, controlPlaneCount, transitType, fabricSitesCount, goodHealthPercentage, goodHealthDeviceCount, totalDeviceCount,poorHealthDeviceCount, fairHealthDeviceCount,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount, transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount, pubsubTransitHealthPercentage, pubsubTransitTotalDeviceCount, pubsubTransitGoodHealthDeviceCount, pubsubTransitPoorHealthDeviceCount, pubsubTransitFairHealthDeviceCount, lispTransitHealthPercentage, lispTransitTotalDeviceCount, lispTransitGoodHealthDeviceCount,lispTransitPoorHealthDeviceCount, lispTransitFairHealthDeviceCount, internetAvailTransitHealthPercentage, internetAvailTransitTotalDeviceCount,internetAvailTransitGoodHealthDeviceCount,internetAvailTransitPoorHealthDeviceCount,internetAvailTransitFairHealthDeviceCount, bgpTcpHealthPercentage,bgpTcpTotalDeviceCount, bgpTcpGoodHealthDeviceCount, bgpTcpPoorHealthDeviceCount, bgpTcpFairHealthDeviceCount]
Examples:
attribute=GoodHealthPercentage (single attribute requested)
attribute=GoodHealthPercentage&attribute=pubsubTransitFairHealthDeviceCount (multiple attributes requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: view
in: query
description: "The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific health data summaries associated with sites.\n\n### Response data proviced by each view: \n\n1. **transitInfo**\n[id, name, siteHierarchy, siteHierarchyId, controlPlaneCount, transitType, fabricSitesCount] \n\n2. **overallHealth**\n[id, name, goodHealthPercentage, goodHealthDeviceCount, totalDeviceCount, poorHealthDeviceCount, fairHealthDeviceCount,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount,transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount ] \n\n3. **transitControlPlaneHealth**\n[id, name,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount,transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, pubsubTransitHealthPercentage, pubsubTransitTotalDeviceCount, pubsubTransitGoodHealthDeviceCount, pubsubTransitPoorHealthDeviceCount, pubsubTransitFairHealthDeviceCount, lispTransitHealthPercentage, lispTransitTotalDeviceCount, lispTransitGoodHealthDeviceCount, lispTransitPoorHealthDeviceCount, lispTransitFairHealthDeviceCount, bgpTcpHealthPercentage, bgpTcpTotalDeviceCount, bgpTcpGoodHealthDeviceCount, bgpTcpPoorHealthDeviceCount, bgpTcpFairHealthDeviceCount] \n\n4. **transitServicesHealth**\n[id, name, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount, internetAvailTransitHealthPercentage, internetAvailTransitTotalDeviceCount, internetAvailTransitGoodHealthDeviceCount,internetAvailTransitPoorHealthDeviceCount, internetAvailTransitFairHealthDeviceCount] \n\nWhen this query parameter is not added the default summaries are: \n\n**[transitInfo, overallHealth]**\n\nExamples:\n\nview=overallHealth (single view requested)\n\nview=transitInfo&view=overallHealth (multiple views requested)\n"
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Health summmary response covering specific transit network and it's health.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/TransitNetworkSummary'
examples:
Response1:
$ref: '#/components/examples/TransitNetworkResponseExample1'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/transitNetworkHealthSummaries/count:
get:
tags:
- transitNetworkHealthSummaries
summary: Read list of Transit Networks with their health summary
description: 'Get a count of transit networks. Use available query parameters to get the count of a subset of transit networks.
This API provides the latest health data from a given `endTime`
If data is not ready for the provided endTime, the request will fail, and the error message will indicate the recommended endTime to use to retrieve a complete data set.
This behavior may occur if the provided endTime=currentTime, since we are not a real time system.
When `endTime` is not provided, the API returns the latest data.'
operationId: readTransitNetworksCount
parameters:
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: id
in: query
description: 'The list of entity Uuids. (Ex."6bef213c-19ca-4170-8375-b694e251101c")
Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested)
id=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with ''&'' separator)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Successfully returned the requested transit networks count
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/CountIntegerResponse'
'400':
description: The client made a request that the server could not understand (for example, the request syntax is incorrect).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: The server could not fulfill the request due to internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
1XX:
description: Informational Responses - The server received the request and sent an informational response.
2XX:
description: Successful Responses - The server received the client request, understood it, and accepted it.
3XX:
description: Redirection Messages - The client must take additional action to complete the request.
4XX:
description: Client Error Responses - The client request caused the error.
5XX:
description: Server Error Responses - The server failed to fulfill the request.
default:
description: Unexpected Error
/transitNetworkHealthSummaries/{id}/trendAnalytics:
get:
tags:
- transitNetworkHealthSummaries
summary: The Trend analytics data for a transit network in the specified time range
description: 'Get health time series for a specific Transit Network by providing the unique Transit Network id in the url path.
The data will be grouped based on the specified trend time interval. If startTime and endTime are not provided, the API defaults to the last 24 hours.
By default:
- the number of records returned will be 500.
- the records will be sorted in time ascending (`asc`) order
'
operationId: readTransitNetworkTrendById
parameters:
- name: id
in: path
description: unique transit network id
required: true
style: simple
explode: false
schema:
type: string
format: uuid
- name: X-CALLER-ID
in: header
description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request.
'
required: false
schema:
type: string
default: unknown
example: ui:client360
- name: startTime
in: query
description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
schema:
type: integer
format: int64
example: 1705348800000
- name: endTime
in: query
description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
'
required: false
schema:
type: integer
format: int64
example: 1705435200000
- name: trendInterval
in: query
description: "The time window to aggregate the metrics. \nInterval can be 5 minutes or 10 minutes or 1 hour or 1 day or 7 days\n"
schema:
type: string
enum:
- 5MIN
- 10MIN
- 1HR
- 1DAY
- 7DAY
- name: limit
in: query
description: Maximum number of records to return
schema:
maximum: 500
minimum: 1
type: integer
default: 500
- name: offset
in: query
description: Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.
schema:
minimum: 1
type: integer
default: 1
- name: order
in: query
description: The sort order of the field ascending or descending.
schema:
type: string
default: asc
enum:
- asc
- desc
- name: attribute
in: query
description: 'Supported Attributes:
[goodHealthPercentage, goodHealthDeviceCount, totalDeviceCount,poorHealthDeviceCount, fairHealthDeviceCount,transitControlPlaneHealthPercentage, transitControlPlaneTotalDeviceCount, transitControlPlaneGoodHealthDeviceCount, transitControlPlanePoorHealthDeviceCount, transitControlPlaneFairHealthDeviceCount, transitServicesHealthPercentage, transitServicesTotalDeviceCount, transitServicesGoodHealthDeviceCount,transitServicesPoorHealthDeviceCount, transitServicesFairHealthDeviceCount, pubsubTransitHealthPercentage, pubsubTransitTotalDeviceCount, pubsubTransitGoodHealthDeviceCount, pubsubTransitPoorHealthDeviceCount, pubsubTransitFairHealthDeviceCount, lispTransitHealthPercentage, lispTransitTotalDeviceCount, lispTransitGoodHealthDeviceCount,lispTransitPoorHealthDeviceCount, lispTransitFairHealthDeviceCount, internetAvailTransitHealthPercentage, internetAvailTransitTotalDeviceCount,internetAvailTransitGoodHealthDeviceCount,internetAvailTransitPoorHealthDeviceCount,internetAvailTransitFairHealthDeviceCount, bgpTcpHealthPercentage,bgpTcpTotalDeviceCount, bgpTcpGoodHealthDeviceCount, bgpTcpPoorHealthDeviceCount, bgpTcpFairHealthDeviceCount]
Examples:
attribute=GoodHealthPercentage (single attribute requested)
attribute=GoodHealthPercentage&attribute=pubsubTransitFairHealthDeviceCount (multiple attributes requested)
'
required: false
style: form
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: Transit networks summmary response covering trend data for a given Transit networks id.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/transitNetworkSummaryTrend'
examples:
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-center/refs/heads/main/openapi/cisco-catalyst-center-transitnetworkhealthsummaries-api-openapi.yml