Obiekt raportu

Następujące obiekty są bezpośrednio powiązane z API report.

Raport

Obiekt raportu ma następujące właściwości:

Właściwość Typ Opis
reportid ID ID raportu.

Zachowanie właściwości:
- tylko do odczytu
- wymagane dla operacji aktualizacji
userid ID ID użytkownika, który utworzył raport.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
name string Unikalna nazwa raportu.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
dashboardid ID ID pulpitu, na podstawie którego tworzony jest raport.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
period integer Okres, za który raport zostanie przygotowany.

Możliwe wartości:
0 - (domyślnie) poprzedni dzień;
1 - poprzedni tydzień;
2 - poprzedni miesiąc;
3 - poprzedni rok.
cycle integer Harmonogram powtarzania okresu.

Możliwe wartości:
0 - (domyślnie) codziennie;
1 - co tydzień;
2 - co miesiąc;
3 - co rok.
start_time integer Pora dnia, w sekundach, o której raport zostanie przygotowany do wysłania.

Domyślnie: 0.
weekdays integer Dni tygodnia do wysyłania raportu.

Możliwe wartości bitmapy:
1 - poniedziałek;
2 - wtorek;
4 - środa;
8 - czwartek;
16 - piątek;
32 - sobota;
64 - niedziela.

To pole jest maską bitową; akceptowana jest dowolna suma możliwych wartości bitmapy (na przykład 21 dla poniedziałku, środy i piątku).

Domyślnie: 0.

Zachowanie właściwości:
- wymagane, jeśli cycle jest ustawione na "weekly".
active_since string Data rozpoczęcia.

Możliwe wartości:
pusty ciąg - (domyślnie) nie określono (zapisywane jako 0);
określona data w formacie YYYY-MM-DD (zapisywana jako znacznik czasu początku dnia (00:00:00)).
active_till string Data zakończenia.

Możliwe wartości:
pusty ciąg - (domyślnie) nie określono (zapisywane jako 0);
określona data w formacie YYYY-MM-DD (zapisywana jako znacznik czasu końca dnia (23:59:59)).
subject string Temat wiadomości raportu.
message string Treść wiadomości raportu.
status integer Czy raport jest włączony, czy wyłączony.

Możliwe wartości:
0 - Wyłączony;
1 - (domyślnie) Włączony.
description text Opis raportu.
state integer Stan raportu.

Możliwe wartości:
0 - (domyślnie) raport nie został jeszcze przetworzony;
1 - raport został wygenerowany i pomyślnie wysłany do wszystkich odbiorców;
2 - generowanie raportu nie powiodło się; "info" zawiera informacje o błędzie;
3 - raport został wygenerowany, ale wysyłka do części (lub wszystkich) odbiorców nie powiodła się; "info" zawiera informacje o błędzie.

Zachowanie właściwości:
- tylko do odczytu
lastsent timestamp Znacznik czasu Unix ostatniego pomyślnie wysłanego raportu.

Zachowanie właściwości:
- tylko do odczytu
info string Opis błędu lub dodatkowe informacje.

Zachowanie właściwości:
- tylko do odczytu

Użytkownicy

Obiekt users ma następujące właściwości:

Właściwość Typ Opis
userid ID ID użytkownika, do którego ma zostać wysłany raport.

Zachowanie właściwości:
- wymagane
access_userid ID ID użytkownika, w imieniu którego raport zostanie wygenerowany.

0 - (domyślnie) Wygeneruj raport przez odbiorcę.
exclude integer Czy wykluczyć użytkownika z listy mailingowej.

Możliwe wartości:
0 - (domyślnie) Uwzględnij;
1 - Wyklucz.

Grupy użytkowników

Obiekt grup użytkowników ma następujące właściwości:

Właściwość Typ Opis
usrgrpid ID ID grupy użytkowników, do której ma zostać wysłany raport.

Zachowanie właściwości:
- wymagane
access_userid ID ID użytkownika, w imieniu którego zostanie wygenerowany raport.

0 - (domyślnie) Wygeneruj raport przez odbiorcę.