Integración de API
Informe
Calendario
2min
Get the list of available reports for scheduling
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
lang
optional
String
EN | IT | DE | ES
Gets the currently active reports schedule of a given customer
GET
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
lang
optional
String
EN | IT | DE | ES
Add a new schedule report on a specified customer
POST
Request
Header Parameters
X-API-KEY
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
reports_id
required
Array
Array of reports id to add in the schedule
recivers
required
Array
Array of emails to send the reports: max 3
days
required
Array
Array of integer of days of the week to be included in the report.
0 stands for monday
...
6 for sunday
hours
required
String
Array of indeger of size 2 to specify the interval of the report. e.g [00,23] stands for all day
interval
required
Number
How often send the reports
1 for once a day
7 for once a week
all_profiles
required
Boolean
True for generate reports for all profiles
profile_code
optional
Integer
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
required
String
API Key for authorization
Body Parameters
customer_code
required
Number
Customer code
id
required
String
Id of the schedule report to remove
Actualizado 14 Jan 2025
¿Esta página le fue útil?