Объект отчета

Следующие объекты напрямую связаны с API report.

Отчет

Объект отчета имеет следующие свойства:

Свойство Тип Описание
reportid ID Идентификатор отчета.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
userid ID Идентификатор пользователя, создавшего отчет.

Поведение свойства:
- обязательно для операций создания
name string Уникальное имя отчета.

Поведение свойства:
- обязательно для операций создания
dashboardid ID Идентификатор панели мониторинга, на основе которой создается отчет.

Поведение свойства:
- обязательно для операций создания
period integer Период, за который будет подготовлен отчет.

Возможные значения:
0 - (по умолчанию) предыдущий день;
1 - предыдущая неделя;
2 - предыдущий месяц;
3 - предыдущий год.
cycle integer Периодичность повторения расписания.

Возможные значения:
0 - (по умолчанию) ежедневно;
1 - еженедельно;
2 - ежемесячно;
3 - ежегодно.
start_time integer Время суток в секундах, когда отчет будет подготовлен к отправке.

По умолчанию: 0.
weekdays integer Дни недели для отправки отчета.

Возможные значения битовой маски:
1 - понедельник;
2 - вторник;
4 - среда;
8 - четверг;
16 - пятница;
32 - суббота;
64 - воскресенье.

Это поле является битовой маской; допустима любая сумма возможных значений битовой маски (например, 21 для понедельника, среды и пятницы).

По умолчанию: 0.

Поведение свойства:
- обязательно, если для cycle задано значение "weekly".
active_since string Дата начала.

Возможные значения:
пустая строка - (по умолчанию) не указано (сохраняется как 0);
конкретная дата в формате YYYY-MM-DD (сохраняется как временная метка начала дня (00:00:00)).
active_till string Дата окончания.

Возможные значения:
пустая строка - (по умолчанию) не указано (сохраняется как 0);
конкретная дата в формате YYYY-MM-DD (сохраняется как временная метка конца дня (23:59:59)).
subject string Тема сообщения отчета.
message string Текст сообщения отчета.
status integer Указывает, включен или отключен отчет.

Возможные значения:
0 - (по умолчанию) включен;
1 - отключен.
description text Описание отчета.
state integer Состояние отчета.

Возможные значения:
0 - (по умолчанию) отчет еще не обработан;
1 - отчет создан и успешно отправлен всем получателям;
2 - не удалось создать отчет; поле "info" содержит информацию об ошибке;
3 - отчет создан, но не удалось отправить его некоторым (или всем) получателям; поле "info" содержит информацию об ошибке.

Поведение свойства:
- только для чтения
lastsent timestamp Временная метка Unix последнего успешно отправленного отчета.

Поведение свойства:
- только для чтения
info string Описание ошибки или дополнительная информация.

Поведение свойства:
- только для чтения

Пользователи

Объект users имеет следующие свойства:

Property Type Description
userid ID ID пользователя, которому нужно отправить отчет.

Поведение свойства:
- required
access_userid ID ID пользователя, от имени которого будет сгенерирован отчет.

0 - (default) Сгенерировать отчет от имени получателя.
exclude integer Исключать ли пользователя из списка рассылки.

Возможные значения:
0 - (default) Включить;
1 - Исключить.

Группы пользователей

Объект групп пользователей имеет следующие свойства:

Property Type Description
usrgrpid ID ID группы пользователей, которой будет отправлен отчет.

Поведение свойства:
- required
access_userid ID ID пользователя, от имени которого будет сгенерирован отчет.

0 - (по умолчанию) Сгенерировать отчет от имени получателя.