Skip to main content
POST
Crear reporte programado

Authorizations

Authorization
string
header
required

Token de sesión Better Auth o API token (atk_...) en el header Authorization: Bearer <token>. Los JWT legacy ya no son válidos.

Body

application/json
name
string
required

Nombre del reporte

reportType
enum<string>
required

Tipo de reporte (inmutable post-creación)

Available options:
trips_history,
stops_history,
speed_excess
assetIds
string[]
required

ObjectIds de assets

Minimum array length: 1
frequency
enum<string>
required

daily: solo hora. weekly: requiere weekDays, no permite monthDays. monthly: requiere monthDays, no permite weekDays.

Available options:
daily,
weekly,
monthly
executionTime
string
required

Hora de ejecución en formato HH:mm

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Example:

"08:30"

periodValue
integer
required
Required range: x >= 1
periodUnit
enum<string>
required
Available options:
hours,
days
controlDays
enum<string>[]
required

Días cuyos datos se incluyen en el reporte

Minimum array length: 1
Available options:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
format
enum<string>[]
required

Formatos de archivo a generar (pdf o xlsx).

Minimum array length: 1
Available options:
pdf,
xlsx
recipients
string<email>[]
required
Minimum array length: 1
reportConfig
object

Configuración específica según tipo de reporte

includeSummary
boolean
default:false
weekDays
integer[]

Requerido si frequency es weekly (0=domingo, 6=sábado). No enviar con daily ni monthly.

Required range: 0 <= x <= 6
monthDays
integer[]

Requerido si frequency es monthly. No enviar con daily ni weekly.

Required range: 1 <= x <= 31
isActive
boolean
default:true

Response

Reporte programado creado exitosamente

_id
string

ID del reporte programado

name
string

Nombre del reporte

clientId
object
createdBy
object
reportType
enum<string>
Available options:
trips_history,
stops_history,
speed_excess
assetIds
object[]
reportConfig
object
includeSummary
boolean
frequency
enum<string>

daily: solo hora. weekly: requiere weekDays. monthly: requiere monthDays.

Available options:
daily,
weekly,
monthly
weekDays
integer[]

Solo aplica si frequency es weekly (0=domingo, 6=sábado)

Required range: 0 <= x <= 6
monthDays
integer[]

Solo aplica si frequency es monthly

Required range: 1 <= x <= 31
executionTime
string
Pattern: ^([01]\d|2[0-3]):[0-5]\d$
Example:

"08:30"

periodValue
integer
periodUnit
enum<string>
Available options:
hours,
days
controlDays
enum<string>[]

Días de la semana cuyos datos se incluyen en el reporte

Available options:
monday,
tuesday,
wednesday,
thursday,
friday,
saturday,
sunday
format
enum<string>[]

Formatos de archivo. Si se envían múltiples, se genera un ZIP.

Available options:
pdf,
xlsx
recipients
string<email>[]
isActive
boolean
nextRunAt
string<date-time>
lastRunAt
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>