{"type":"api","title":"Get Summary (All)","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/426c8f7edc2cc0036fbe8fd4ce0d3ec2eda7fa14/de857a95-32cb-3f3c-8d64-0bf8514993f9","info":{"title":"Meraki Integrated API for Secure Connect","description":"The Cisco Meraki Integrated API for Secure Connect is a modern REST API based on the OpenAPI specification.\n ---\n\n [API Documentation](https://meraki.io/api)\n\n [Meraki Homepage](https://www.meraki.com)\n","version":"1.8.0","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"}},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"Reports"},{"name":"Activity"},{"name":"Top Categories"},{"name":"Organization Requests by Timerange and Category"},{"name":"Total Requests"},{"name":"Summary"},{"name":"Applications"},{"name":"Deployments"},{"name":"Data Center"},{"name":"Network Devices"},{"name":"Organization Tunnel"},{"name":"Policy"},{"name":"Firewall Applications"},{"name":"Policies"},{"name":"Destination Lists"},{"name":"Destinations"}],"x-parser-conf":{"theme":"meraki","expand":2,"exampleAsDefault":true,"groupBy":{"$remoteModule":"config/group_api_tag.js"}},"openapi":"3.0.0","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/secureConnect/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"tags":["Reports","Summary"],"summary":"Get Summary (All)","description":"Get the summary report","operationId":"getSummary","security":[{"meraki_api_key":[]}],"parameters":[{"name":"organizationId","in":"path","description":"Organization ID associated with this resource.","required":true,"schema":{"type":"integer"}},{"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"},{"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"},{"name":"offset","in":"query","description":"A number that represents an index in the collection.","schema":{"type":"number","default":0},"example":0},{"name":"limit","in":"query","description":"The maximum number of records to return from the collection.","required":true,"schema":{"type":"number","default":100},"example":100},{"name":"domains","in":"query","description":"A domain name or comma-delimited list of domain name.","schema":{"type":"string"},"example":"cisco.com,nasa.gov"},{"name":"urls","in":"query","description":"A URL or comma-delimited list of URL.","schema":{"type":"string"},"example":"https://google.com,facebook.com/help"},{"name":"categories","in":"query","description":"A category ID or comma-delimited list of category ID.","schema":{"type":"string"},"example":"148,151,66"},{"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"},{"name":"ip","in":"query","description":"An IP address","schema":{"type":"string"},"example":"10.10.10.10"},{"name":"ports","in":"query","description":"A port number or comma-delimited list of port number.","schema":{"type":"string"},"example":"7351,80"},{"name":"identityids","in":"query","description":"An identity ID or comma-delimited list of identity ID.","schema":{"type":"string"},"example":"1,2,3"},{"name":"identitytypes","in":"query","description":"An identity type or comma-delimited list of identity type.","schema":{"type":"string"},"example":"network,roaming"},{"name":"applicationid","in":"query","description":"An application ID.","schema":{"type":"string"},"example":"1"},{"name":"verdict","in":"query","description":"A verdict string or comma-delimited list of verdict string.","schema":{"type":"string"},"example":"allowed,blocked,proxied"},{"name":"ruleid","in":"query","description":"A firewall policy rule ID.","schema":{"type":"number"},"example":1},{"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_*"},{"name":"securityoverridden","in":"query","description":"Specify whether to filter on requests that override security.","schema":{"type":"boolean"},"example":true},{"name":"bundleid","in":"query","description":"A proxy bundle ID.","schema":{"type":"number"},"example":1},{"name":"threats","in":"query","description":"A threat name or comma-delimited list of threat name.","schema":{"type":"string"}},{"name":"threattypes","in":"query","description":"A threat type or comma-delimited list of threat type.","schema":{"type":"string"}},{"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"},{"name":"antivirusthreats","in":"query","description":"A threat name or comma-delimited list of threat name.","schema":{"type":"string"},"example":"Trojan.Linux.Generic.144075"},{"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"},{"name":"filternoisydomains","in":"query","description":"filter out domains that generate a lot of insignificant traffic (noise).","schema":{"type":"boolean"},"example":true}],"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":"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}},"meta":{"type":"object","description":"Meta data","example":{}}},"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","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error"},"code":{"type":"integer","description":"The status code of the error.","example":500}},"example":{"message":"Bad Request","code":400}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error"},"code":{"type":"integer","description":"The status code of the error.","example":500}},"example":{"message":"Unauthorized","code":401}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error"},"code":{"type":"integer","description":"The status code of the error.","example":500}},"example":{"message":"Forbidden","code":403}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error"},"code":{"type":"integer","description":"The status code of the error.","example":500}},"example":{"message":"Not Found","code":404}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The description of the error.","example":"Internal Server Error"},"code":{"type":"integer","description":"The status code of the error.","example":500}},"example":{"message":"Internal Server Error","code":500}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z"}}}},"__originalOperationId":"getSummary","method":"get","path":"/organizations/{organizationId}/reports/summary"}}