{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-gov/cdd8786b84e1e4d80528d0eeb25987c136a18549/1791efa2-be44-3482-bc75-43e83b0a1c73","info":{"title":"Cisco Umbrella for Government API Usage Reports","version":"2.0.0","description":"Get the Umbrella for Government API usage reports for an organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"API Usage Report","description":"API Usage reports"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/reports/api-usage-overview.md"}},"openapi":"3.0.0","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.apiusage:read":"Read the API Usage reports"}}}}}},"spec":{"type":"object","description":"The information about the API key usage.","required":["from","to","count","items"],"properties":{"from":{"type":"string","description":"The date and time where to start reading in the collection.","example":"2023-12-03","$$ref":"#/components/schemas/from"},"to":{"type":"string","description":"The date and time where to stop reading in the collection.","example":"2023-12-05","$$ref":"#/components/schemas/to"},"count":{"type":"integer","format":"int32","description":"The total number of API requests.","example":450,"$$ref":"#/components/schemas/count"},"items":{"type":"array","description":"The information about the API key usage.","items":{"type":"object","required":["count","requests","keyName","keyId"],"properties":{"keyName":{"type":"string","description":"The name of the API key.","example":"Deployments API key"},"keyId":{"type":"string","description":"The ID of the API key.","example":"12345345345a"},"count":{"type":"integer","format":"int32","description":"The total number of API requests.","example":450,"$$ref":"#/components/schemas/count"},"requests":{"type":"array","description":"The list of API request information.","items":{"type":"object","required":["path","verb","count"],"properties":{"path":{"type":"string","description":"The path of the API endpoint.","example":"/reports/v2/activity/proxy"},"verb":{"type":"string","description":"The name of the API operation.","example":"GET"},"count":{"type":"integer","description":"The number of requests to the API endpoint.","format":"int64","example":928}},"example":{"path":"/auth/v2/token","verb":"POST","count":928}},"example":[{"path":"/auth/v2/token","verb":"POST","count":928}],"$$ref":"#/components/schemas/requestDetailsList"}}},"example":[{"keyName":"Reports and Policies API key","keyId":"ajsdk12455555","count":400,"requests":[{"path":"/reports/v2/activity/proxy","verb":"GET","count":546},{"path":"/policies/v2/destinationlists","verb":"POST","count":16},{"path":"/policies/v2/destinationlists","verb":"GET","count":4}]}],"$$ref":"#/components/schemas/keysInformation"}},"example":{"from":"2023-12-03","to":"2023-12-04","count":100,"items":[{"keyName":"Reports and Policies API key","keyId":"ajsdk12455555","count":400,"requests":[{"path":"/reports/v2/activity/proxy","verb":"GET","count":546},{"path":"/policies/v2/destinationlists","verb":"POST","count":16},{"path":"/policies/v2/destinationlists","verb":"GET","count":4}]}]},"$$ref":"#/components/schemas/keys","title":"keys"}}