Get Summary (All) - Cloud Security API

{"type":"api","title":"Get Summary (All)","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/d1093732-2fd9-3760-ac85-83910c4b7111","info":{"title":"Cisco Secure Access Reporting API","description":"The Reporting API provides the data to generate the Secure Access reports.","version":"2.0.1","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Activity"},{"name":"Top Identities"},{"name":"Identity Distribution"},{"name":"Top Resources"},{"name":"Top Destinations"},{"name":"Top Categories"},{"name":"Top Event Types"},{"name":"Top DNS Query Types"},{"name":"Organization Requests by Hour"},{"name":"Organization Requests by Timerange"},{"name":"Organization Requests by Hour and Category"},{"name":"Organization Requests by Timerange and Category"},{"name":"Deployment Status"},{"name":"Bandwidth by Hour"},{"name":"Bandwidth by Timerange"},{"name":"Top Files"},{"name":"Total Requests"},{"name":"Top Threats"},{"name":"Top Threat Types"},{"name":"Utility"},{"name":"Top IPs"},{"name":"Summary"},{"name":"Summaries by Category"},{"name":"Summaries by Destination"},{"name":"Summaries by Rule"},{"name":"Remote Access"},{"name":"Private Resource"},{"name":"Requests Resource Connector"},{"name":"Requests Summary Resource Connector Groups"},{"name":"Resource Connectors"},{"name":"Rules Activity"},{"name":"Unique Resources"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/reports/reporting-overview.md","uri":"secure-access-api-reference-reporting-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.granularEvents:read":"Read reports granular events","reports.utilities:read":"Read reports utilities","reports.aggregations:read":"Read reports aggregations","reports.summariesByRule:read":"Read reports for the summaries of the rule","reports.privateResources:read":"Read reports for the private resources"}}}}}},"spec":{"tags":["Summary","Secure Access"],"summary":"Get Summary (All)","description":"Get the summary report.\n\n**Access Scope:** Reports \u003e Aggregations \u003e Read-Only","operationId":"getSummary","security":[{"oauthFlow":["reports.aggregations:read"]}],"parameters":[{"name":"from","in":"query","description":"A timestamp or relative time string (for example: '-1days').\nFilter for data that appears after this time.","required":true,"schema":{"type":"string"},"example":"1639146300000","$$ref":"#/components/parameters/fromParam"},{"name":"to","in":"query","description":"A timestamp or relative time string (for example: 'now').\nFilter for data that appears before this time.","required":true,"schema":{"type":"string"},"example":"1640010300000","$$ref":"#/components/parameters/toParam"},{"name":"offset","in":"query","description":"A number that represents an index in the collection.","schema":{"type":"number","default":0},"example":0,"$$ref":"#/components/parameters/offsetParam"},{"name":"domains","in":"query","description":"A domain name or comma-delimited list of domain name.","schema":{"type":"string"},"example":"cisco.com,nasa.gov","$$ref":"#/components/parameters/domainsParam"},{"name":"urls","in":"query","description":"A URL or comma-delimited list of URL.","schema":{"type":"string"},"example":"https://google.com,facebook.com/help","$$ref":"#/components/parameters/urlsParam"},{"name":"categories","in":"query","description":"A category ID or comma-delimited list of category ID.","schema":{"type":"string"},"example":"148,151,66","$$ref":"#/components/parameters/categoriesParam"},{"name":"policycategories","in":"query","description":"A category ID or comma-delimited list of category ID.\nFilter the request by the categories that trigger a policy.","schema":{"type":"string"},"example":"67,69","$$ref":"#/components/parameters/policyCategoriesParam"},{"name":"ip","in":"query","description":"An IP address.","schema":{"type":"string"},"example":"10.10.10.10","$$ref":"#/components/parameters/ipParam"},{"name":"ports","in":"query","description":"A port number or comma-delimited list of port numbers.","schema":{"type":"string"},"example":"7351,80","$$ref":"#/components/parameters/portsParam"},{"name":"identityids","in":"query","description":"An identity ID or comma-delimited list of identity IDs.","schema":{"type":"string"},"example":"1,2,3","$$ref":"#/components/parameters/identityIdsParam"},{"name":"identitytypes","in":"query","description":"An identity type or comma-delimited list of identity types.","schema":{"type":"string"},"example":"network,roaming","$$ref":"#/components/parameters/identityTypesParam"},{"name":"applicationid","in":"query","description":"The ID of the application.","schema":{"type":"string"},"example":"1","$$ref":"#/components/parameters/applicationIdParam"},{"name":"verdict","in":"query","description":"A string or comma-delimited string that describes whether the traffic can reach the destination.","schema":{"type":"string"},"example":"allowed,blocked","$$ref":"#/components/parameters/verdictParam"},{"name":"ruleid","in":"query","description":"The firewall policy rule ID.","schema":{"type":"number"},"example":1,"$$ref":"#/components/parameters/ruleIdParam"},{"name":"filename","in":"query","description":"A string that identifies a filename. Filter the request by the filename.\nSupports globbing or use of the wildcard character ('*'). The asterisk (*) matches\nzero or more occurrences of any character.","schema":{"type":"string"},"example":"myfilename_*","$$ref":"#/components/parameters/filenameParam"},{"name":"securityoverridden","in":"query","description":"Specify whether to filter on requests that override security.","schema":{"type":"boolean"},"example":true,"$$ref":"#/components/parameters/securityOverriddenParam"},{"name":"bundleid","in":"query","description":"A proxy bundle ID.","schema":{"type":"number"},"example":1,"$$ref":"#/components/parameters/bundleIdParam"},{"name":"threats","in":"query","description":"A threat name or comma-delimited list of threat names.","schema":{"type":"string"},"$$ref":"#/components/parameters/threatsParam"},{"name":"threattypes","in":"query","description":"A threat type or comma-delimited list of threat types.","schema":{"type":"string"},"$$ref":"#/components/parameters/threatTypesParam"},{"name":"ampdisposition","in":"query","description":"An AMP disposition string or a comma-delimited list of AMP disposition strings.","schema":{"type":"string"},"example":"clean,malicious,unknown","$$ref":"#/components/parameters/ampDispositionParam"},{"name":"antivirusthreats","in":"query","description":"A threat name or comma-delimited list of threat names.","schema":{"type":"string"},"example":"Trojan.Linux.Generic.144075","$$ref":"#/components/parameters/antivirusThreatsParam"},{"name":"datalosspreventionstate","in":"query","description":"A string that describes the status of a destination.\nFilter for requests that are blocked by the DLP layer security.","schema":{"type":"string","enum":["blocked"]},"example":"blocked","$$ref":"#/components/parameters/dataLossPreventionStateParam"},{"name":"filternoisydomains","in":"query","description":"Filter out domains that generate a lot of insignificant traffic (noise).","schema":{"type":"boolean"},"example":true,"$$ref":"#/components/parameters/filterNoisyDomainsParam"},{"name":"timezone","in":"query","description":"Display the timestamp of the traffic events in the specified timezone.\nFor the timezone, provide a continent and city separated by an url-encoded forward slash ('/'), for example: timezone='ASIA%2fCALCUTTA'.","schema":{"type":"string"},"example":"ASIA%2fCALCUTTA","$$ref":"#/components/parameters/timezoneParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"The summary information about the requests.","properties":{"applications":{"type":"number","description":"The total number of applications (avc or total)."},"domains":{"type":"number","description":"The total number of domains."},"requestsblocked":{"type":"number","description":"The total number of domains."},"filetypes":{"type":"number","description":"The total number of domains."},"policycategories":{"type":"number","description":"The total number of blocked categories."},"policyrequests":{"type":"number","description":"The total number of policy requests."},"requests":{"type":"number","description":"The total number of requests."},"requestsallowed":{"type":"number","description":"The total number of allowed requests."},"categories":{"type":"number","description":"The total number of categories."},"identitytypes":{"type":"number","description":"The total number of identity types."},"applicationsblocked":{"type":"number","description":"The total number of blocked applications."},"files":{"type":"number","description":"The total number of files."},"identities":{"type":"number","description":"The total number of identities."},"applicationsallowed":{"type":"number","description":"The total number of allowed applications."}},"required":["applications","applicationsallowed","applicationsblocked","categories","domains","files","filetypes","identities","identitytypes","policycategories","policyrequests","requests","requestsallowed","requestsblocked"],"example":{"applications":123,"domains":82,"requestsblocked":189,"filetypes":0,"policycategories":2,"policyrequests":2,"requests":189,"requestsallowed":10,"categories":11,"identitytypes":1,"applicationsblocked":2,"files":5,"identities":1,"applicationsallowed":2},"$$ref":"#/components/schemas/Summary"},"meta":{"type":"object","description":"The properties of the metadata.","example":{},"$$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"example":{"data":{"applications":123,"domains":82,"requestsblocked":189,"filetypes":0,"policycategories":2,"policyrequests":2,"requests":189,"requestsallowed":10,"categories":11,"identitytypes":1,"applicationsblocked":2,"files":5,"identities":1,"applicationsallowed":2},"meta":{}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Bad Request"}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized"}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Not Found"}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Internal Server Error"}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getSummary","method":"get","path":"/summary"}}