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:

Property Type Description
reportid ID ID raportu.

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

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

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

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

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.

Wartość domyślna: 0.
weekdays integer Dni tygodnia, w których raport będzie wysyłany.

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

To pole jest maską bitową; dopuszczalna jest dowolna suma możliwych wartości bitmapowych (na przykład 21 oznacza poniedziałek, środę i piątek).

Wartość domyślna: 0.

Zachowanie właściwości:
- wymagane, jeśli cycle ma wartość „weekly”.
active_since string Data rozpoczęcia.

Możliwe wartości:
pusty ciąg - (domyślnie) nie określono (przechowywane jako 0);
określona data w formacie YYYY-MM-DD (przechowywana 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 (przechowywane jako 0);
określona data w formacie YYYY-MM-DD (przechowywana jako znacznik czasu końca dnia (23:59:59)).
subject string Temat wiadomości raportu.
message string Treść wiadomości raportu.
status integer Określa, czy raport jest włączony, czy wyłączony.

Możliwe wartości:
0 - (domyślnie) włączony;
1 - wyłą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ę; pole „info” zawiera informacje o błędzie;
3 - raport został wygenerowany, ale wysyłanie do niektórych lub wszystkich odbiorców nie powiodło się; pole „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ę.