{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-gov/cdd8786b84e1e4d80528d0eeb25987c136a18549/afd656c6-fbb7-361d-909e-7dd25ff9b7a2","info":{"title":"Cisco Umbrella for Government Reporting API","description":"The Reporting API provides the data to generate the Umbrella reports.","version":"2.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":"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":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/reporting-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"reports/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.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"}}}}}},"spec":{"type":"object","description":"The properties of the category and summary.","properties":{"category":{"type":"object","description":"The properties of the category.","properties":{"id":{"type":"number","description":"The ID of the category."},"label":{"type":"string","description":"The descriptive label for the category."},"type":{"type":"string","description":"The type of the category."},"integration":{"type":"boolean","description":"Specifies whether the category is an integration.","example":true},"deprecated":{"type":"boolean","description":"Specifies whether the category is a legacy category.","example":true}},"$$ref":"#/components/schemas/Category"},"summary":{"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"}},"required":["category","summary"],"example":{"category":{"id":66,"label":"Malware","type":"security","integration":true},"summary":{"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/SummaryWithCategory","title":"SummaryWithCategory"}}