API-Integration
Bericht
Zeitplan
2min
Get the list of available reports for scheduling
GET
Request
Header Parameters
X-API-KEY
String
required
API Key for authorization
Body Parameters
customer_code
Number
required
Customer code
lang
String
optional
EN | IT | DE | ES
Gets the currently active reports schedule of a given customer
GET
Request
Header Parameters
X-API-KEY
String
required
API Key for authorization
Body Parameters
customer_code
Number
required
Customer code
lang
String
optional
EN | IT | DE | ES
Add a new schedule report on a specified customer
POST
Request
Header Parameters
X-API-KEY
String
required
API Key for authorization
Body Parameters
customer_code
Number
required
Customer code
reports_id
Array
required
Array of reports id to add in the schedule
recivers
Array
required
Array of emails to send the reports: max 3
days
Array
required
Array of integer of days of the week to be included in the report.
0 stands for monday
...
6 for sunday
hours
String
required
Array of indeger of size 2 to specify the interval of the report. e.g [00,23] stands for all day
interval
Number
required
How often send the reports
1 for once a day
7 for once a week
all_profiles
Boolean
required
True for generate reports for all profiles
profile_code
Integer
optional
If all_profiles is false, specify a profile to generate the reports
Remove a report scheduling from a customer
POST
Request
Header Parameters
X-API-KEY
String
required
API Key for authorization
Body Parameters
customer_code
Number
required
Customer code
id
String
required
Id of the schedule report to remove
Aktualisiert 15 Apr 2025
Hat Ihnen diese Seite geholfen?