Passer au contenu principal
PUT
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

schedule
string | null
requis

L'ID de l'horaire, un UUID. Omettez-le pour créer un nouvel horaire.

Corps

application/json

Un rapport planifié ou une alerte à enregistrer : ce qu'il envoie ou surveille, quand, à qui et comment, et, pour une alerte, sa condition et sa période de silence.

kind
enum<string>
requis

report envoie une vue ou un tableau de bord selon son horaire. alert surveille un KPI ou une vue et envoie un courriel lorsque sa condition est remplie.

Options disponibles:
report,
alert
name
string
requis

Le nom de l'horaire, d'au plus 120 caractères, tel qu'affiché dans la liste des horaires.

Maximum string length: 120
subject
enum<string>
requis

Ce que l'horaire envoie ou surveille : view, dashboard ou kpi. Un rapport envoie une vue ou un tableau de bord; une alerte surveille une vue ou un KPI.

Options disponibles:
view,
dashboard,
kpi
subject_id
string<uuid>
requis

L'ID de la vue, du tableau de bord ou de l'indicateur clé.

frequency
enum<string>
requis

À quelle fréquence elle s'exécute : daily, weekly, monthly ou cron, dans le fuseau horaire de l'organisation.

Options disponibles:
daily,
weekly,
monthly,
cron
at
string
requis

L'heure de la journée à laquelle il s'exécute, sous forme de HH:MM, comme 08:00.

view_version
integer | null

La version d'une vue à envoyer. Elle reste à cette version jusqu'à ce qu'elle soit modifiée. La plus récente si elle est omise.

Plage requise: x >= 1
weekday
integer | null

Pour une planification hebdomadaire, le jour où elle s'exécute : de 1 pour lundi à 7 pour dimanche.

Plage requise: 1 <= x <= 7
day
integer | null

Pour une planification mensuelle, le jour du mois où elle s'exécute, de 1 à 28.

Plage requise: 1 <= x <= 28
cron
string | null

Pour une planification cron, une expression à cinq champs, comme 0 8 * * 1-5.

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

Pour un rapport, la manière dont il parvient à ses destinataires : link, attachment ou both.

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

Pour un rapport, le format de fichier : csv, xlsx, workbook ou pdf.

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

Les ID des membres qui la reçoivent. Envoyez users, roles ou les deux.

Maximum array length: 100
roles
string[]

Les noms des rôles dont les membres le reçoivent. Envoyez users, roles ou les deux.

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

Pour une alerte, sa condition : above, below, rises, falls ou status.

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

Pour une alerte, la limite, le pourcentage de hausse ou de baisse, ou pour status le statut warning ou bad. Un nombre est envoyé sous forme de texte décimal.

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

Pour une alerte, les minutes suivant une alerte pendant lesquelles elle n'en envoie aucune autre, jusqu'à 10,080 (une semaine).

Plage requise: 0 <= x <= 10080

Réponse

ScheduleSavedResource

data
ScheduleSavedResource · object
requis

Un rapport planifié ou une alerte tel qu'il est après un enregistrement ou une mise en pause. Lisez la liste des planifications pour le reste.