Documentation
Table of Contents
> Report object
Następujące obiekty są bezpośrednio powiązane z interfejsem API report.
Report
Obiekt report ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| reportid | string | (tylko do odczytu) ID raportu. |
| userid (wymagane) |
string | ID użytkownika, który utworzył raport. |
| name (wymagane) |
string | Unikalna nazwa raportu. |
| dashboardid (wymagane) |
string | ID pulpitu, na którym oparty jest raport. |
| period | integer | Okres, dla którego raport zostanie przygotowany. Możliwe wartości: 0 - (domyślne) poprzedni dzień; 1 - poprzedni tydzień; 2 - poprzedni miesiąc; 3 - poprzedni rok. |
| cycle | integer | Harmonogram powtarzania cyklu. Możliwe wartości: 0 - (domyślne) codziennie; 1 - co tydzień; 2 - co miesiąc; 3 - co rok. |
| start_time | integer | Godzina dnia, w sekundach, kiedy raport zostanie przygotowany do wysłania. Domyślne: 0. |
| weekdays | integer | Dni tygodnia, w których będzie wysyłany raport. Wymagane tylko dla raportów tygodniowych. Dni tygodnia są przechowywane w formie binarnej, gdzie każdy bit reprezentuje odpowiedni dzień tygodnia. Na przykład, 12 oznacza 1100 w systemie binarnym i oznacza, że raporty będą wysyłane w każdą środę i czwartek. Domyślnie: 0. |
| active_since | string | Data rozpoczęcia wysyłania raportów. Możliwe wartości: pusty ciąg znaków - (domyślne) nieokreślono (przechowywane jako 0); konkretna data w formacie YYYY-MM-DD (przechowywane jako znacznik czasu początku dnia (00:00:00)). |
| active_till | string | Data zakończenia wysyłania raportów. Możliwe wartości: pusty ciąg znaków - (domyślne) nieokreślono (przechowywane jako 0); konkretna data w formacie YYYY-MM-DD (przechowywane jako znacznik czasu końca dnia (23:59:59)). |
| subject | string | Temat wiadomości raportu. |
| message | string | Tekst wiadomości raportu. |
| status | integer | Czy raport jest włączony czy wyłączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślne) Włączony. |
| description | text | Opis raportu. |
| state | integer | (tylko do odczytu) Stan raportu. Możliwe wartości: 0 - (domyślne) raport jeszcze nie został przetworzony; 1 - raport został wygenerowany i pomyślnie wysłany do wszystkich odbiorców; 2 - nie udało się wygenerować raportu; "info" zawiera informacje o błędzie; 3 - raport został wygenerowany, ale wysłanie do niektórych (lub wszystkich) odbiorców nie powiodło się; "info" zawiera informacje o błędzie. |
| lastsent | timestamp | (tylko do odczytu) Unixowy znacznik czasu ostatniego pomyślnie wysłanego raportu. |
| info | string | (tylko do odczytu) Opis błędu lub dodatkowe informacje. |
Należy pamiętać, że w przypadku niektórych metod (aktualizacja, usuwanie) wymagana/opcjonalna kombinacja parametrów jest inna.
Users
Obiekt users ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| userid (wymagane) |
string | ID użytkownika, do którego ma zostać wysłany raport. |
| access_userid | string | ID użytkownika, w imieniu którego raport zostanie wygenerowany. 0 - (domyślne) Generuj raport przez odbiorcę. |
| exclude | integer | Czy wykluczyć użytkownika z listy mailingowej. Możliwe wartości: 0 - (domyślne) Uwzględnij; 1 - Wykluczyć. |
User groups
Obiekt user groups ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| usrgrpid (wymagane) |
string | ID grupy użytkowników, do której ma zostać wysłany raport. |
| access_userid | string | ID użytkownika, w imieniu którego raport zostanie wygenerowany. 0 - (domyślne) Generuj raport przez odbiorcę. |