Oggetto report

I seguenti oggetti sono direttamente correlati all'API report.

Report

L'oggetto report presenta le seguenti proprietà:

Property Type Description
reportid ID ID del report.

Property behavior:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
userid ID ID dell'utente che ha creato il report.

Property behavior:
- obbligatoria per le operazioni di creazione
name string Nome univoco del report.

Property behavior:
- obbligatoria per le operazioni di creazione
dashboardid ID ID della dashboard su cui si basa il report.

Property behavior:
- obbligatoria per le operazioni di creazione
period integer Periodo per il quale verrà preparato il report.

Valori possibili:
0 - (predefinito) giorno precedente;
1 - settimana precedente;
2 - mese precedente;
3 - anno precedente.
cycle integer Pianificazione con ripetizione del periodo.

Valori possibili:
0 - (predefinito) giornaliera;
1 - settimanale;
2 - mensile;
3 - annuale.
start_time integer Ora del giorno, in secondi, in cui il report verrà preparato per l'invio.

Predefinito: 0.
weekdays integer Giorni della settimana in cui inviare il report.

Valori bitmap possibili:
1 - lunedì;
2 - martedì;
4 - mercoledì;
8 - giovedì;
16 - venerdì;
32 - sabato;
64 - domenica.

Questo è un campo bitmask; è accettabile qualsiasi somma dei valori bitmap possibili (ad esempio, 21 per lunedì, mercoledì e venerdì).

Predefinito: 0.

Property behavior:
- obbligatoria se cycle è impostato su "weekly".
active_since string Data di inizio.

Valori possibili:
stringa vuota - (predefinito) non specificata (memorizzata come 0);
data specifica nel formato YYYY-MM-DD (memorizzata come timestamp dell'inizio della giornata (00:00:00)).
active_till string Data di fine.

Valori possibili:
stringa vuota - (predefinito) non specificata (memorizzata come 0);
data specifica nel formato YYYY-MM-DD (memorizzata come timestamp della fine della giornata (23:59:59)).
subject string Oggetto del messaggio del report.
message string Testo del messaggio del report.
status integer Indica se il report è abilitato o disabilitato.

Valori possibili:
0 - (predefinito) abilitato;
1 - disabilitato.
description text Descrizione del report.
state integer Stato del report.

Valori possibili:
0 - (predefinito) il report non è ancora stato elaborato;
1 - il report è stato generato e inviato correttamente a tutti i destinatari;
2 - la generazione del report non è riuscita; "info" contiene informazioni sull'errore;
3 - il report è stato generato, ma l'invio ad alcuni o a tutti i destinatari non è riuscito; "info" contiene informazioni sull'errore.

Property behavior:
- sola lettura
lastsent timestamp Timestamp Unix dell'ultimo report inviato correttamente.

Property behavior:
- sola lettura
info string Descrizione dell'errore o informazioni aggiuntive.

Property behavior:
- sola lettura

Utenti

L'oggetto users ha le seguenti proprietà:

Proprietà Tipo Descrizione
userid ID ID dell'utente a cui inviare il report.

Comportamento della proprietà:
- obbligatoria
access_userid ID ID dell'utente per conto del quale verrà generato il report.

0 - (predefinito) Genera il report per destinatario.
exclude integer Indica se escludere l'utente dalla mailing list.

Valori possibili:
0 - (predefinito) Includi;
1 - Escludi.

Gruppi di utenti

L'oggetto dei gruppi di utenti ha le seguenti proprietà:

Proprietà Type Descrizione
usrgrpid ID ID del gruppo di utenti a cui inviare il report.

Comportamento della proprietà:
- obbligatorio
access_userid ID ID dell'utente per conto del quale verrà generato il report.

0 - (predefinito) Genera il report in base al destinatario.