{"type":"api","title":"Get Summary by Type","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/ca1cb6ac-c651-3cb6-9746-527b35467f3c","info":{"title":"Reporting API","description":"The Reporting API provides the data to generate the reports as seen on the Umbrella dashboard.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Activity"},{"name":"Top Identities"},{"name":"Identity Distribution"},{"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":"MSP Deployment Status"},{"name":"MSP Requests by Hour"},{"name":"MSP Requests by Timerange"},{"name":"MSP Requests by Organization"},{"name":"MSP Requests by Category"},{"name":"MSP Requests by Destination"},{"name":"MSP Category Requests by Organization"},{"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 (Intrusion)"},{"name":"Remote Access"}],"x-parser-conf":{"oAuth2":{"clientId":"","clientSecret":"","proxyEnabled":true},"meta":{"useProxy":true}},"openapi":"3.0.1","servers":[{"url":"https://reports.api.umbrella.com/{basePath}","variables":{"basePath":{"default":"v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://management.api.umbrella.com/auth/v2/oauth2/token","scopes":{}}}}}},"spec":{"tags":["Summary"],"summary":"Get Summary by Type","description":"List the summary by type.","operationId":"getSummaryType","parameters":[{"name":"type","in":"path","description":"Specify the type of traffic. Valid values: dns, proxy, firewall, or ip","required":true,"schema":{"type":"string"},"example":"firewall","$$ref":"#/components/parameters/typeDnsWebIpFirewallParam"},{"name":"organizationid","in":"path","description":"The organization ID","required":true,"schema":{"type":"number"},"example":1234567,"$$ref":"#/components/parameters/organizationIdParam"},{"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 into the collection.","schema":{"type":"number"},"example":0,"$$ref":"#/components/parameters/offsetParam"},{"name":"limit","in":"query","description":"The maximum number of records to return from the collection.","required":true,"schema":{"type":"number"},"example":100,"$$ref":"#/components/parameters/limitParam"},{"name":"domains","in":"query","description":"A domain name or comma-delimited list of domain name.","schema":{"type":"string"},"example":"google.com,facebook.com","$$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 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 number.","schema":{"type":"string"},"example":"7351,80","$$ref":"#/components/parameters/portsParam"},{"name":"identityids","in":"query","description":"An identity ID or comma-delimited list of identity ID.","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 type.","schema":{"type":"string"},"example":"network,roaming","$$ref":"#/components/parameters/identityTypesParam"},{"name":"applicationid","in":"query","description":"An application ID.","schema":{"type":"string"},"example":"1","$$ref":"#/components/parameters/applicationIdParam"},{"name":"verdict","in":"query","description":"A verdict string or comma-delimited list of verdict string.","schema":{"type":"string"},"example":"allowed,blocked,proxied","$$ref":"#/components/parameters/verdictParam"},{"name":"ruleid","in":"query","description":"A 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 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 name.","schema":{"type":"string"},"$$ref":"#/components/parameters/threatsParam"},{"name":"threattypes","in":"query","description":"A threat type or comma-delimited list of threat type.","schema":{"type":"string"},"$$ref":"#/components/parameters/threatTypesParam"},{"name":"ampdisposition","in":"query","description":"An AMP disposition string or a comma-delimited list of AMP disposition string.","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 name.","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 (for example: 'blocked').\nFilter data for requests that were blocked to protect data.","schema":{"type":"string"},"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"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"applications":{"type":"number","description":"total number of applications (avc or total)"},"domains":{"type":"number","description":"total number of domains"},"requestsblocked":{"type":"number","description":"total number of blocked requests"},"filetypes":{"type":"number","description":"total number of file types"},"policycategories":{"type":"number","description":"total number of blocked categories"},"policyrequests":{"type":"number","description":"total number of policy requests"},"requests":{"type":"number","description":"total number of requests"},"requestsallowed":{"type":"number","description":"total number of allowed requests"},"categories":{"type":"number","description":"total number of categories"},"identitytypes":{"type":"number","description":"total number of identity types"},"applicationsblocked":{"type":"number","description":"total number of blocked applications"},"files":{"type":"number","description":"total number of files"},"identities":{"type":"number","description":"total number of identities"},"applicationsallowed":{"type":"number","description":"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","example":{},"$$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"example":{"data":{"applications":123,"domains":82,"requestsblocked":189,"filetypes":0,"policycategories":2,"requests":189,"requestsallowed":10,"categories":11,"identitytypes":1,"applicationsblocked":2,"files":5,"identities":1,"applicationsallowed":2,"policyrequests":3},"meta":{}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Invalid request"}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized request"}}}},"$$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":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Server error"}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getSummaryType","security":[{"oauthFlow":[]}],"method":"get","path":"/organizations/{organizationid}/summary/{type}"}}