{ "opencollection": "1.0.0", "info": { "name": "DNSFilter Agent Local User Bulk Deletes Traffic Reports API", "version": "2026-07-13" }, "items": [ { "info": { "name": "Traffic Reports", "type": "folder" }, "items": [ { "info": { "name": "Total requests/time", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_requests", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_networks", "value": "", "type": "query", "description": "Group report result by network id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for sites in a period of time." }, { "info": { "name": "Total requests geo", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_requests_geo", "params": [ { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for organizations in a period of time\nfor the heatmap on overview." }, { "info": { "name": "Total requests/organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_requests_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_organizations", "value": "", "type": "query", "description": "Group report result by organization id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for organizations in a period of time." }, { "info": { "name": "Total requests clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_requests_agents", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_agents", "value": "", "type": "query", "description": "Group report result by agent id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for roaming clients in a period of time." }, { "info": { "name": "Total requests users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_requests_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_users", "value": "", "type": "query", "description": "Group report result by user id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for users in a period of time." }, { "info": { "name": "Total requests collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_requests_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_collections", "value": "", "type": "query", "description": "Group report result by collection id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for collections in a period of time." }, { "info": { "name": "Total threats/time", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_threats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "show_individual_networks", "value": "", "type": "query", "description": "Group report result by network id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of threats for sites in a period of time." }, { "info": { "name": "Total threats organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_threats_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "show_individual_organizations", "value": "", "type": "query", "description": "Group report result by organization id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of threats for organizations in a period of time." }, { "info": { "name": "Total threats clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_threats_agents", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "show_individual_agents", "value": "", "type": "query", "description": "Group report result by agent id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of threats for roaming clients in a period of time." }, { "info": { "name": "Total threats users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_threats_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "show_individual_users", "value": "", "type": "query", "description": "Group report result by user id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of threats for users in a period of time." }, { "info": { "name": "Total threats collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_threats_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "show_individual_collections", "value": "", "type": "query", "description": "Group report result by collection id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of threats for collections in a period of time." }, { "info": { "name": "Total category requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_categories", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_networks", "value": "", "type": "query", "description": "Group report result by network id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by category for sites in a period of time." }, { "info": { "name": "Category reqs organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_categories_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_organizations", "value": "", "type": "query", "description": "Group report result by organization id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by category for organizations in a period of time." }, { "info": { "name": "Category reqs clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_categories_agents", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_agents", "value": "", "type": "query", "description": "Group report result by agent id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by category for roaming clients in a period of time." }, { "info": { "name": "Category reqs users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_categories_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_users", "value": "", "type": "query", "description": "Group report result by user id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by category for users in a period of time." }, { "info": { "name": "Category reqs collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_categories_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_collections", "value": "", "type": "query", "description": "Group report result by collection id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by category for collections in a period of time." }, { "info": { "name": "Total domain reqs", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_domains", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_networks", "value": "", "type": "query", "description": "Group report result by network id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by domain for sites in a period of time." }, { "info": { "name": "Domain reqs organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_domains_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_organizations", "value": "", "type": "query", "description": "Group report result by organization id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by domain for organizations in a period of time." }, { "info": { "name": "Domain reqs users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_domains_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_users", "value": "", "type": "query", "description": "Group report result by user id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by domain for users in a period of time." }, { "info": { "name": "Domain reqs collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_domains_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_collections", "value": "", "type": "query", "description": "Group report result by collection id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by domain for collections in a period of time." }, { "info": { "name": "Total collection reqs", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_networks", "value": "", "type": "query", "description": "Group report result by network id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by collection for sites in a period of time." }, { "info": { "name": "Collection reqs orgs", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_collections_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_organizations", "value": "", "type": "query", "description": "Group report result by organization id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by collection for organizations in a period of time." }, { "info": { "name": "Collection reqs clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_collections_agents", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_agents", "value": "", "type": "query", "description": "Group report result by agent id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by collection for roaming clients in a period of time." }, { "info": { "name": "Collection reqs users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_collections_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_users", "value": "", "type": "query", "description": "Group report result by user id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests by collection for users in a period of time." }, { "info": { "name": "Queries per second", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/qps", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *1min*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 1 hour (ex.: \"Last Hour\"), bucket size is one minute\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "show_individual_networks", "value": "", "type": "query", "description": "Group report result by network id, defaults to false" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of queries per second in a period of time for sites." }, { "info": { "name": "QPS organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/qps_active_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for organizations." }, { "info": { "name": "QPS clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/qps_active_agents", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for roaming clients." }, { "info": { "name": "QPS users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/qps_active_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for users." }, { "info": { "name": "QPS collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/qps_active_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of queries per second in a period of time\n(maximum 20 minutes) for collections." }, { "info": { "name": "Top domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_domains", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "fqdn", "value": "", "type": "query", "description": "search for FQDNs that contains this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if set to all" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top requested domains in a period of time." }, { "info": { "name": "Top categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_categories", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only categories whose name contains this value" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if set to all" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top categories domains in a period of time." }, { "info": { "name": "Top application categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_application_categories", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only application whose name contains this value" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if set to all" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top application categories domains in a period of time." }, { "info": { "name": "Top organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_organizations", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "name", "value": "", "type": "query", "description": "Only organizations whose name contains this value (and are included in the organizations_ids list)" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top organizations in a period of time." }, { "info": { "name": "Top networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_networks", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "name", "value": "", "type": "query", "description": "Only networks whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top networks in a period of time." }, { "info": { "name": "Top agents", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_agents", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only user agents whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top agents in a period of time." }, { "info": { "name": "Top users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_users", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only local users whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top users in a period of time." }, { "info": { "name": "Top collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_collections", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only local users whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top collections in a period of time." }, { "info": { "name": "Query Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/query_logs", "params": [ { "name": "agent_id", "value": "", "type": "query", "description": "User agent UUID" }, { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of User agent UUIDs" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_id", "value": "", "type": "query", "description": "Collection ID" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of Collection IDs" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "fqdn", "value": "", "type": "query", "description": "search for FQDNs that contains this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_id", "value": "", "type": "query", "description": "Network ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "question_type", "value": "", "type": "query", "description": "Question Type of queries, defaults to all" }, { "name": "result", "value": "", "type": "query", "description": "Type of report (all, blocked only, allowed only), defaults to all" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "user_id", "value": "", "type": "query", "description": "User local ID" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of User local IDs" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the query raw logs in a period of time." }, { "info": { "name": "Organization stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_organizations_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only applications whose display name contains this value" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of stats for organizations in a period of time." }, { "info": { "name": "Domain stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_domain_stats", "params": [ { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "fqdn", "value": "", "type": "query", "description": "Only search for FQDNs that contains this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognize" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of stats for a domain in a period of time." }, { "info": { "name": "Category stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_category_stats", "params": [ { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognize" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of stats for a category in a period of time." }, { "info": { "name": "Total Org Requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_organizations_requests", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "category_ids", "value": "", "type": "query", "description": "Comma separated list of category IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "fqdn", "value": "", "type": "query", "description": "search for FQDNs that contains this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only applications whose display name contains this value" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for organizations in a period of time." }, { "info": { "name": "Total Domain Requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_domain_requests", "params": [ { "name": "domain", "value": "", "type": "query", "description": "Only search for domains that starts with this value" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the total number of requests for a domain in a period of time." }, { "info": { "name": "Top Organizations Requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/top_organizations_requests", "params": [ { "name": "bucket_size", "value": "", "type": "query", "description": "Desired bucket size, possible values: *auto*, *15min*, *1day*, defaults to *auto*\n*Auto*:\n If report from/to range is less than 24 hours (ex.: \"Today\" and \"Yesterday\"), bucket size is fifteen minutes\n If report from/to range is greater than 24 hours (ex.: \"Last 7 days\" and \"Last 14 days\"), bucket size is one day" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number (defaults to 1) and size (defaults to 10, maximum 100)." }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the top organizations by number of requests." }, { "info": { "name": "Total client stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_client_stats", "params": [ { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the organization network, users and client stats." }, { "info": { "name": "Deployments", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_deployments", "params": [ { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the organization deployments information." }, { "info": { "name": "Roaming clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_roaming_clients", "params": [ { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID, defaults to user organization ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the roaming clients information." }, { "info": { "name": "Application requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_applications_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only applications whose display name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the statistics of number of requests by application in a period of time." }, { "info": { "name": "Application reqs org", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_applications_organizations_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID" }, { "name": "name", "value": "", "type": "query", "description": "Only organizations whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the statistics of number of requests for organizations\nby application in a period of time." }, { "info": { "name": "Applications reqs networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_applications_networks_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "name", "value": "", "type": "query", "description": "Only networks whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the statistics of number of requests for sites by application in a period of time." }, { "info": { "name": "Application reqs clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_applications_agents_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "name", "value": "", "type": "query", "description": "Only user agents whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the statistics of number of requests for roaming clients\nby application in a period of time." }, { "info": { "name": "Application reqs users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_applications_users_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "name", "value": "", "type": "query", "description": "Only local users whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the statistics of number of requests for users by\napplication in a period of time." }, { "info": { "name": "Application reqs collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/traffic_reports/total_applications_collections_stats", "params": [ { "name": "agent_ids", "value": "", "type": "query", "description": "Comma separated list of user agent UUIDs, defaults to all" }, { "name": "agent_types", "value": "", "type": "query", "description": "Comma separated list of user agent types, defaults to all" }, { "name": "application_category_ids", "value": "", "type": "query", "description": "Comma separated list of application category IDs, defaults to all" }, { "name": "application_ids", "value": "", "type": "query", "description": "Comma separated list of application IDs, defaults to all" }, { "name": "collection_ids", "value": "", "type": "query", "description": "Comma separated list of collection IDs, defaults to all" }, { "name": "from", "value": "", "type": "query", "description": "Report UTC lower limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime minus 1 day or if format is not recognized" }, { "name": "mac_addresses", "value": "", "type": "query", "description": "Comma separated list of MAC addresses (without colons) or filter values, defaults to all" }, { "name": "name", "value": "", "type": "query", "description": "Only local users whose name contains this value" }, { "name": "nat_ips", "value": "", "type": "query", "description": "Comma separated list of NAT IPs, defaults to all (valid integer list from 101 to 106)" }, { "name": "network_ids", "value": "", "type": "query", "description": "Comma separated list of networks IDs, defaults to all" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Comma separated list of organization IDs, defaults to user organization ID" }, { "name": "private_ip", "value": "", "type": "query", "description": "Private LAN IP" }, { "name": "private_ip_from", "value": "", "type": "query", "description": "Private LAN IP range, lower limit" }, { "name": "private_ip_to", "value": "", "type": "query", "description": "Private LAN IP range, upper limit" }, { "name": "security_report", "value": "", "type": "query", "description": "Threats report true/false, *both* (threats and non-threats) if it is empty or not sent" }, { "name": "source", "value": "", "type": "query", "description": "Comma separated list of desired traffic source (networks, user agents, proxies), defaults to all" }, { "name": "to", "value": "", "type": "query", "description": "Report UTC upper limit, format YYYY-MM-DDThh:mm:ss or YYYY-MM-DDThh:mm:ssZ, defaults to current UTC datetime or if format is not recognized" }, { "name": "type", "value": "", "type": "query", "description": "Type of report (all, allowed, blocked), defaults to all" }, { "name": "user_ids", "value": "", "type": "query", "description": "Comma separated list of local user IDs, defaults to all" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the statistics of number of requests for collections\nby application in a period of time." } ] } ], "bundled": true }