⚙️API Integration
Report

Traffic Reports

10min
Gets the top categories requested in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
bucket_size
required
String
Timing range The bucket size must be one of the following types: 24h, 48h, 72h, 7days, 1month, 6month 24h = Last 24h report 48h = Last 48h report 72h = Last 72h report 7days = Last 7 days report 1month = Last month report 6month = Last 6 months report
category_type
required
Number
The category type Category Type must be one of the following types: 1, 2 1 = Blocked categories 2 = Allowed categories
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets the top domains requested in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
bucket_size
required
String
Timing range The bucket size must be one of the following types: 24h, 48h, 72h, 7days, 1month, 6month 24h = Last 24h report 48h = Last 48h report 72h = Last 72h report 7days = Last 7 days report 1month = Last month report 6month = Last 6 months report
request_type
required
Number
The request type Request Type must be one of the following types: 1, 2, 3 1 = Blocked request 2 = Allowed request 3 = NX unresolved request
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets statistics in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
bucket_size
required
String
Timing range The bucket size must be one of the following types: 24h, 48h, 72h, 7days, 1month, 6month 24h = Last 24h report 48h = Last 48h report 72h = Last 72h report 7days = Last 7 days report 1month = Last month report 6month = Last 6 months report
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets hourly requests (blocked and allowed) in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
bucket_size
required
String
Timing range The bucket size must be one of the following types: 24h, 48h, 72h, 7days, 1month, 6month 24h = Last 24h report 48h = Last 48h report 72h = Last 72h report 7days = Last 7 days report 1month = Last month report 6month = Last 6 months report
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets the total number of blocked requests by category for customer in a period of time. Sorted by categories with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and category name, defaults EN
macro_code
optional
Number
Only search for mcarocatogy, defaults to all See panel/categories/macro/list for accepted values

Gets the total number of allowed requests by category for customer in a period of time. Sorted by categories with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and category name, defaults EN
macro_code
optional
Number
Only search for mcarocatogy, defaults to all See panel/categories/macro/list for accepted values

Gets the total number of allowed requests by categories deemed dangerous for customer in a period of time. Sorted by categories with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and category name, defaults EN

Gets the total number of blocked requests by malware categories for customer in a period of time. Sorted by categories with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and category name, defaults EN

Gets the total number of blocked requests by macrocategory for customer in a period of time. Sorted by macrocategories with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and macro category name, defaults EN

Gets the total number of allowed requests by macrocategory for customer in a period of time. Sorted by macrocategories with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and macro category name, defaults EN

Gets the total number of allowed requests by country for customer in a period of time. Sorted by countries with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and country name, defaults EN
region_code
optional
String
Only search for country region code, defaults to all See panel/countries/region/list for accepted values

Gets the total number of allowed requests by country region for customer in a period of time. Sorted by countries with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
lang
optional
String
Language for the report name and region name, defaults EN

Gets the total number of blocked requests by malware domain for customer in a period of time. Sorted by domains with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets the total number of allowed requests by domain for customer in a period of time. Sorted by domains with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
category_code
optional
String
Only search for category, defaults to all See panel/categories/list for accepted values
lang
optional
String
Language for the category name, defaults EN

Gets the total number of blocked requests by domain for customer in a period of time. Sorted by domains with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list
category_code
optional
String
Only search for category, defaults to all See panel/categories/list for accepted values
lang
optional
String
Language for the category name, defaults EN

Gets the total number of nx requests by domain for customer in a period of time. Sorted by domains with more requests
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_datetime
required
String
Report lower limit, format Y-m-d H:i:s (on customer timezone)
end_datetime
required
String
Report upper limit, format Y-m-d H:i:s (on customer timezone)
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets the traffic hourly (allowed and blocked) for customer in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_date
required
String
Report lower limit, format Y-m-d
end_date
required
String
Report upper limit, format Y-m-d
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets the traffic daily (allowed and blocked) for customer in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_date
required
String
Report lower limit, format Y-m-d
end_date
required
String
Report upper limit, format Y-m-d
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list

Gets the traffic weekly (allowed and blocked) for customer in a period of time
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
start_date
required
String
Report lower limit, format Y-m-d
end_date
required
String
Report upper limit, format Y-m-d
profile_code
optional
Number
Only search for profile, defaults to all See panel/profiles/list for profiles list




Updated 06 Sep 2024
Doc contributor
Doc contributor
Doc contributor
Did this page help you?
PREVIOUS
API Documentation for Developers
NEXT
Protection
Docs powered by Archbee