{"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 information about the top identity requests.","properties":{"requests":{"type":"number","description":"The total number of requests made by this identity."},"bandwidth":{"type":"number","nullable":true,"description":"The amount of bandwidth","$$ref":"#/components/schemas/bandwidth"},"identity":{"type":"object","description":"The information about the identity.","properties":{"id":{"type":"number","description":"The ID of the identity."},"label":{"type":"string","description":"The descriptive label for the identity."},"type":{"type":"object","description":"The information about the identity including the type.","properties":{"id":{"type":"number","description":"The ID of the origin type for the identity."},"label":{"type":"string","description":"The label of the origin type for the identity."},"type":{"type":"string","description":"The name of the origin type for the identity."}},"$$ref":"#/components/schemas/IdentityType"},"deleted":{"type":"boolean","description":"Indicates whether the identity was deleted.","example":true}},"required":["id","label","type","deleted"],"example":{"id":1,"label":"Catch Rate Testing System","type":{"id":21,"label":"Sites","type":"site"},"deleted":false},"$$ref":"#/components/schemas/Identity"},"counts":{"type":"object","description":"The information about the requests.","properties":{"requests":{"type":"number","description":"The total number of requests.","example":123},"allowedrequests":{"type":"number","description":"The number of requests that were allowed.","example":60},"blockedrequests":{"type":"number","description":"The number of requests that were blocked.","example":63}},"example":{"requests":123,"allowedrequests":60,"blockedrequests":63},"$$ref":"#/components/schemas/RequestCounts"},"rank":{"type":"number","description":"The rank of the result based on the number of requests.","$$ref":"#/components/schemas/rank"}},"required":["bandwidth","counts","identity","rank","requests"],"example":{"requests":3827,"bandwidth":7051943359,"identity":{"id":1,"label":"Catch Rate Testing System","type":{"id":21,"label":"Sites","type":"site"},"deleted":false},"counts":{"requests":123,"allowedrequests":60,"blockedrequests":63},"rank":3},"$$ref":"#/components/schemas/TopIdentity","title":"TopIdentity"}}