[comment]: # aside: 1

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

Os seguintes objetos estão diretamente relacionados à API `report`.

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

[comment]: # ({956fb953-94caf5ac})
### Relatório

O objeto relatório possui as seguintes propriedades:

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|reportid|ID|ID do relatório.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *obrigatório* para operações de atualização|
|userid|ID|ID do usuário que criou o relatório.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|name|string|Nome exclusivo do relatório.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|dashboardid|ID|ID do dashboard no qual o relatório se baseia.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|period|integer|Período para o qual o relatório será preparado.<br><br>Valores possíveis:<br>0 - *(padrão)* dia anterior;<br>1 - semana anterior;<br>2 - mês anterior;<br>3 - ano anterior.|
|cycle|integer|Agendamento de repetição do período.<br><br>Valores possíveis:<br>0 - *(padrão)* diariamente;<br>1 - semanalmente;<br>2 - mensalmente;<br>3 - anualmente.|
|start\_time|integer|Hora do dia, em segundos, em que o relatório será preparado para envio.<br><br>Padrão: 0.|
|weekdays|integer|Dias da semana para envio do relatório.<br><br>Valores possíveis de bitmap:<br>1 - Segunda-feira;<br>2 - Terça-feira;<br>4 - Quarta-feira;<br>8 - Quinta-feira;<br>16 - Sexta-feira;<br>32 - Sábado;<br>64 - Domingo.<br><br>Este é um campo de máscara de bits; qualquer soma dos valores possíveis de bitmap é aceitável (por exemplo, 21 para Segunda, Quarta e Sexta).<br><br>Padrão: 0.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `cycle` estiver definido como "semanal".|
|active\_since|string|Data de início.<br><br>Valores possíveis:<br>string vazia - *(padrão)* não especificado (armazenado como 0);<br>data específica no formato AAAA-MM-DD (armazenada como timestamp do início do dia (00:00:00)).|
|active\_till|string|Data de término.<br><br>Valores possíveis:<br>string vazia - *(padrão)* não especificado (armazenado como 0);<br>data específica no formato AAAA-MM-DD (armazenada como timestamp do final do dia (23:59:59)).|
|subject|string|Assunto da mensagem do relatório.|
|message|string|Texto da mensagem do relatório.|
|status|integer|Se o relatório está habilitado ou desabilitado.<br><br>Valores possíveis:<br>0 - Desabilitado;<br>1 - *(padrão)* Habilitado.|
|description|text|Descrição do relatório.|
|state|integer|Estado do relatório.<br><br>Valores possíveis:<br>0 - *(padrão)* relatório ainda não processado;<br>1 - relatório foi gerado e enviado com sucesso para todos os destinatários;<br>2 - falha ao gerar o relatório; "info" contém informações sobre o erro;<br>3 - relatório foi gerado, mas o envio para alguns (ou todos) destinatários falhou; "info" contém informações sobre o erro.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|lastsent|timestamp|Timestamp Unix do último relatório enviado com sucesso.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|info|string|Descrição do erro ou informações adicionais.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|

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

[comment]: # ({430dcb22-b2778637})
### Usuários

O objeto users possui as seguintes propriedades:

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|userid|ID|ID do usuário para o qual o relatório será enviado.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|access\_userid|ID|ID do usuário em nome do qual o relatório será gerado.<br><br>0 - *(padrão)* Gerar relatório pelo destinatário.|
|exclude|integer|Se deve excluir o usuário da lista de envio.<br><br>Valores possíveis:<br>0 - *(padrão)* Incluir;<br>1 - Excluir.|

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

[comment]: # ({ddadc564-483e81dc})
### Grupos de usuários

O objeto de grupos de usuários possui as seguintes propriedades:

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|usrgrpid|ID|ID do grupo de usuários para o qual o relatório será enviado.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|access\_userid|ID|ID do usuário em nome de quem o relatório será gerado.<br><br>0 - *(padrão)* Gerar relatório pelo destinatário.|

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