Get Summary - Cloud Security API

{"type":"api","title":"Get Summary","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/eb145afb-23bf-3669-8aa6-a86cb8aee573","info":{"title":"Cisco Secure Access API Usage API","version":"2.0.0","description":"Get the Cisco Secure Access API usage reports for an organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"API Usage Report","description":"API Usage reports"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/reports/api-usage-overview.md","uri":"secure-access-api-reference-api-usage-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"reports.apiusage:read":"Read the API Usage reports"}}}}}},"spec":{"operationId":"getAPIUsageSummary","summary":"Get Summary","description":"Get the total number API requests, and the counts of the successful and failed API requests within a specific time period.","tags":["API Usage Report","Secure Access"],"security":[{"oauthFlow":["reports.apiusage:read"]}],"parameters":[{"name":"from","in":"query","description":"The date and time specified in the RFC-3339 format, for example: 2023-10-01.\nFilter the collection for data that appears after this time.","required":true,"schema":{"type":"string"},"example":"2023-10-01","$$ref":"#/components/parameters/from"},{"name":"to","in":"query","description":"The date and time specified in the RFC-3339 format, for example: 2023-10-01.\nFilter the collection for data that appears before this time.","required":true,"schema":{"type":"string"},"example":"2023-10-01T 20:23:00Z","$$ref":"#/components/parameters/to"},{"name":"apiKeys","in":"query","description":"Sort the collection using a list of comma-separated API key IDs.","required":false,"schema":{"type":"string"},"example":"123abfs77632","$$ref":"#/components/parameters/apiKeys"},{"name":"paths","in":"query","description":"Sort the collection using a list of comma-separated API resource paths.","required":false,"schema":{"type":"string"},"example":"policies/v2/destinationlists/1234556,policies/v2/destinationlists","$$ref":"#/components/parameters/paths"},{"name":"verbs","in":"query","description":"Sort the collection using a list of comma-separated HTTP verbs.\nThe HTTP verb strings are case sensitive.","required":false,"schema":{"type":"string"},"example":"GET,POST,PUT","$$ref":"#/components/parameters/verbs"},{"name":"statusCodes","in":"query","description":"Sort the collection using a list of comma-separated HTTP status codes.","required":false,"schema":{"type":"string"},"example":"200,204,429","$$ref":"#/components/parameters/statusCodes"},{"name":"userAgents","in":"query","description":"Sort the collection using a list of comma-separated labels that describe the HTTP client programs.","required":false,"schema":{"type":"string"},"example":"python-requests/2.20.0,Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36","$$ref":"#/components/parameters/userAgents"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The summary of the API usage.","required":["data"],"properties":{"data":{"type":"object","description":"The total number of requsts and the counts of the failed and successful requests.","required":["successfulRequests","failedRequests","total"],"properties":{"successfulRequests":{"type":"integer","description":"The number of successful API requests.","example":20},"failedRequests":{"type":"integer","description":"The number of failed API requests.","example":5},"total":{"type":"integer","description":"The total number of API requests.","example":25}}}},"example":{"data":{"successfulRequests":20,"failedRequests":5,"total":25}},"$$ref":"#/components/schemas/summary"},"example":{"data":{"successfulRequests":20,"failedRequests":5,"total":25}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error","$$ref":"#/components/schemas/message"},"code":{"type":"integer","description":"The status code of the error.","example":500,"$$ref":"#/components/schemas/code"}},"example":{"message":"Bad Request","code":400}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error","$$ref":"#/components/schemas/message"},"code":{"type":"integer","description":"The status code of the error.","example":500,"$$ref":"#/components/schemas/code"}},"example":{"message":"Unauthorized","code":401}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error","$$ref":"#/components/schemas/message"},"code":{"type":"integer","description":"The status code of the error.","example":500,"$$ref":"#/components/schemas/code"}},"example":{"message":"Forbidden","code":403}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error","$$ref":"#/components/schemas/message"},"code":{"type":"integer","description":"The status code of the error.","example":500,"$$ref":"#/components/schemas/code"}},"example":{"message":"Not Found","code":404}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error","$$ref":"#/components/schemas/message"},"code":{"type":"integer","description":"The status code of the error.","example":500,"$$ref":"#/components/schemas/code"}},"example":{"message":"Internal Server Error","code":500}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getAPIUsageSummary","method":"get","path":"/apiUsage/summary"}}