Get site energy by ID - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Get site energy by ID","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getSiteEnergyByID","tags":["Sites"],"summary":"Get site energy by ID","deprecated":false,"description":"Retrieve the energy summary data for a specific site based on the site ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-sitesEnergy-1.0.1-resolved.yaml","parameters":[{"name":"X-CALLER-ID","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.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"id","description":"The UUID of the Site. (Ex. \"6bef213c-19ca-4170-8375-b694e251101c\")","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"startTime","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.\n\nIf `startTime` is not provided, API will default to one day before `endTime`.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","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.\n\nIf `endTime` is not provided, API will default to one day after `startTime`. If `startTime` is not provided either, API will default to current time.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"views","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. **Site**\n[id, siteHierarchy, siteHierarchyId, siteType, latitude, longitude] \n\n2. **Energy**\n[energyConsumed, estimatedCost, estimatedEmission, carbonIntensity, numberOfDevices] \n\nWhen this query parameter is not added the default summaries are: \n\n**[site,energy]**\n\nExamples:\n\nviews=site (single view requested)\n\nviews=site,energy (multiple views requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"Supported Attributes:\n\n[id, siteHierarchy, siteHierarchyId, siteType, latitude, longitude, energyConsumed, estimatedCost, estimatedEmission, carbonIntensity, numberOfDevices]\n\nIf length of attribute list is too long, please use 'view' param instead.\n\nExamples:\n\nattribute=siteHierarchy (single attribute requested)\n\nattribute=siteHierarchy&attribute=energyConsumed (multiple attributes requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceCategory","description":"The list of device categories. Note that this filter specifies which devices will be included when calculating energy consumption values, rather than specifying the list of returned sites. \n\nExamples:\n\n`deviceCategory=Switch` (single device category requested)\n\n`deviceCategory=Switch&deviceCategory=Router` (multiple device categories with comma separator)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"taskId","description":"used to retrieve asynchronously processed & stored data. When this parameter is used, the rest of the request params will be ignored.\n","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Site Energy Summaries Response model on success","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":""},"siteName":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"siteHierarchyId":{"type":"string","description":""},"siteType":{"type":"string","description":""},"latitude":{"type":"number","description":""},"longitude":{"type":"number","description":""},"deviceCategories":{"type":"array","items":{"type":"string"},"description":""},"energyConsumed":{"type":"number","description":""},"estimatedCost":{"type":"number","description":""},"estimatedEmission":{"type":"number","description":""},"carbonIntensity":{"type":"number","description":""},"numberOfDevices":{"type":"integer","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetSiteEnergyByIDResponse"}}}},"202":{"description":"Response model for asynchronous APIs to use for providing corresponding task information to API caller","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"62ad-aba7-4ec8-9429","x-rapi-overview":"Retrieve the energy summary data for a specific site based on the site ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-sitesEnergy-1.0.1-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Sites","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/energy/sites/${id}","x-rapi-publicPath":"/dna/data/api/v1/energy/sites/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getSiteEnergyByID","method":"get","path":"/dna/data/api/v1/energy/sites/{id}"}}