Saltar al contenido principal
PUT
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

schedule
string | null
requerido

El ID del programa, un UUID. No lo envíes para crear un programa nuevo.

Cuerpo

application/json

Un informe programado o una alerta para guardar: qué envía o vigila, cuándo, a quién y cómo, y para una alerta su condición y su período de silencio.

kind
enum<string>
requerido

report envía una vista o un panel según su programación. alert vigila un KPI o una vista y envía un correo electrónico cuando se cumple su condición.

Opciones disponibles:
report,
alert
name
string
requerido

El nombre del programa, de máximo 120 caracteres, tal como se muestra en la lista de programas.

Maximum string length: 120
subject
enum<string>
requerido

Qué envía o vigila la programación: view, dashboard o kpi. Un reporte envía una vista o un panel; una alerta vigila una vista o un KPI.

Opciones disponibles:
view,
dashboard,
kpi
subject_id
string<uuid>
requerido

El ID de la vista, el panel o el KPI.

frequency
enum<string>
requerido

Cada cuánto se ejecuta: daily, weekly, monthly o cron, en la zona horaria de la organización.

Opciones disponibles:
daily,
weekly,
monthly,
cron
at
string
requerido

La hora del día a la que se ejecuta, como HH:MM, por ejemplo 08:00.

view_version
integer | null

La versión de una vista que se envía. Se queda en esa versión hasta que se cambie. La más reciente si no se envía.

Rango requerido: x >= 1
weekday
integer | null

Para una programación semanal, el día en que se ejecuta: 1 para lunes a 7 para domingo.

Rango requerido: 1 <= x <= 7
day
integer | null

Para una programación mensual, el día del mes en que se ejecuta, de 1 a 28.

Rango requerido: 1 <= x <= 28
cron
string | null

Para una programación cron, una expresión de cinco campos, como 0 8 * * 1-5.

Maximum string length: 100
delivery
enum<string> | null

Para un informe, cómo llega a sus destinatarios: link, attachment o both.

Opciones disponibles:
link,
attachment,
both
format
enum<string> | null

Para un informe, el formato de archivo: csv, xlsx, workbook o pdf.

Opciones disponibles:
csv,
xlsx,
workbook,
pdf
users
integer[]

Los IDs de los miembros que lo reciben. Envía users, roles o ambos.

Maximum array length: 100
roles
string[]

Los nombres de los roles cuyos miembros lo reciben. Envía users, roles o ambos.

Maximum array length: 50
Maximum string length: 255
operator
enum<string> | null

Para una alerta, su condición: above, below, rises, falls o status.

Opciones disponibles:
above,
below,
rises,
falls,
status
value
string | null

Para una alerta, el límite, el porcentaje de un aumento o una caída, o para status el estado warning o bad. Un número se envía como texto decimal.

Maximum string length: 32
Pattern: ^-?\d{1,18}(\.\d{1,12})?$
quiet_minutes
integer | null

Para una alerta, los minutos después de una alerta durante los cuales no envía otra, hasta 10,080 (una semana).

Rango requerido: 0 <= x <= 10080

Respuesta

ScheduleSavedResource

data
ScheduleSavedResource · object
requerido

Un informe programado o una alerta tal como queda después de guardarlo o pausarlo. Lee la lista de programaciones para ver el resto.