[comment]: # aside: 1

[comment]: # ({49ff320e-6b675424})
# Объект отчета

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

[comment]: # ({/49ff320e-6b675424})

[comment]: # ({956fb953-94caf5ac})
### Отчет

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|reportid|ID|ID отчета.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *обязательно* для операций обновления|
|userid|ID|ID пользователя, создавшего отчет.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|name|string|Уникальное имя отчета.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|dashboardid|ID|ID панели, на основе которой формируется отчет.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания|
|period|integer|Период, за который будет подготовлен отчет.<br><br>Возможные значения:<br>0 - *(по умолчанию)* предыдущий день;<br>1 - предыдущая неделя;<br>2 - предыдущий месяц;<br>3 - предыдущий год.|
|cycle|integer|Периодичность повторения.<br><br>Возможные значения:<br>0 - *(по умолчанию)* ежедневно;<br>1 - еженедельно;<br>2 - ежемесячно;<br>3 - ежегодно.|
|start\_time|integer|Время суток в секундах, когда отчет будет подготовлен к отправке.<br><br>По умолчанию: 0.|
|weekdays|integer|Дни недели для отправки отчета.<br><br>Возможные значения битовой маски:<br>1 - понедельник;<br>2 - вторник;<br>4 - среда;<br>8 - четверг;<br>16 - пятница;<br>32 - суббота;<br>64 - воскресенье.<br><br>Это поле является битовой маской; допустима любая сумма возможных значений битовой маски (например, 21 для понедельника, среды и пятницы).<br><br>По умолчанию: 0.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*, если `cycle` установлен в "weekly".|
|active\_since|string|Дата начала.<br><br>Возможные значения:<br>пустая строка - *(по умолчанию)* не указано (хранится как 0);<br>конкретная дата в формате YYYY-MM-DD (хранится как временная метка начала дня (00:00:00)).|
|active\_till|string|Дата окончания.<br><br>Возможные значения:<br>пустая строка - *(по умолчанию)* не указано (хранится как 0);<br>конкретная дата в формате YYYY-MM-DD (хранится как временная метка конца дня (23:59:59)).|
|subject|string|Тема сообщения отчета.|
|message|string|Текст сообщения отчета.|
|status|integer|Включен отчет или отключен.<br><br>Возможные значения:<br>0 - Отключен;<br>1 - *(по умолчанию)* Включен.|
|description|text|Описание отчета.|
|state|integer|Состояние отчета.<br><br>Возможные значения:<br>0 - *(по умолчанию)* отчет еще не был обработан;<br>1 - отчет был сгенерирован и успешно отправлен всем получателям;<br>2 - не удалось сгенерировать отчет; "info" содержит информацию об ошибке;<br>3 - отчет был сгенерирован, но отправка некоторым (или всем) получателям не удалась; "info" содержит информацию об ошибке.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|lastsent|timestamp|Unix timestamp последнего успешно отправленного отчета.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|info|string|Описание ошибки или дополнительная информация.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|

[comment]: # ({/956fb953-94caf5ac})

[comment]: # ({430dcb22-b2778637})
### Пользователи

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userid|ID|ID пользователя, которому нужно отправить отчет.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|access\_userid|ID|ID пользователя, от имени которого будет сгенерирован отчет.<br><br>0 - *(default)* Сгенерировать отчет от имени получателя.|
|exclude|integer|Исключать ли пользователя из списка рассылки.<br><br>Возможные значения:<br>0 - *(default)* Включить;<br>1 - Исключить.|

[comment]: # ({/430dcb22-b2778637})

[comment]: # ({ddadc564-483e81dc})
### Группы пользователей

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|usrgrpid|ID|ID группы пользователей, которой будет отправлен отчет.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *required*|
|access\_userid|ID|ID пользователя, от имени которого будет сгенерирован отчет.<br><br>0 - *(по умолчанию)* Сгенерировать отчет от имени получателя.|

[comment]: # ({/ddadc564-483e81dc})