Objeto de informe

Los siguientes objetos están directamente relacionados con la API report.

Reporte

El objeto reporte tiene las siguientes propiedades:

Propiedad Tipo Descripción
reportid ID ID del reporte.

Comportamiento de la propiedad:
- solo lectura
- requerido para operaciones de actualización
userid ID ID del usuario que creó el reporte.

Comportamiento de la propiedad:
- requerido para operaciones de creación
name string Nombre único del reporte.

Comportamiento de la propiedad:
- requerido para operaciones de creación
dashboardid ID ID del dashboard en el que se basa el reporte.

Comportamiento de la propiedad:
- requerido para operaciones de creación
period integer Periodo para el que se preparará el reporte.

Valores posibles:
0 - (por defecto) día anterior;
1 - semana anterior;
2 - mes anterior;
3 - año anterior.
cycle integer Programación de repetición del periodo.

Valores posibles:
0 - (por defecto) diario;
1 - semanal;
2 - mensual;
3 - anual.
start_time integer Hora del día, en segundos, en la que se preparará el reporte para su envío.

Por defecto: 0.
weekdays integer Días de la semana para enviar el reporte.

Valores posibles de la máscara de bits:
1 - Lunes;
2 - Martes;
4 - Miércoles;
8 - Jueves;
16 - Viernes;
32 - Sábado;
64 - Domingo.

Este es un campo de máscara de bits; cualquier suma de los valores posibles es aceptable (por ejemplo, 21 para Lunes, Miércoles y Viernes).

Por defecto: 0.

Comportamiento de la propiedad:
- requerido si cycle está establecido en "semanal".
active_since string Fecha de inicio.

Valores posibles:
cadena vacía - (por defecto) no especificado (almacenado como 0);
fecha específica en formato AAAA-MM-DD (almacenado como timestamp del inicio del día (00:00:00)).
active_till string Fecha de finalización.

Valores posibles:
cadena vacía - (por defecto) no especificado (almacenado como 0);
fecha específica en formato AAAA-MM-DD (almacenado como timestamp del final del día (23:59:59)).
subject string Asunto del mensaje del reporte.
message string Texto del mensaje del reporte.
status integer Indica si el reporte está habilitado o deshabilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.
description text Descripción del reporte.
state integer Estado del reporte.

Valores posibles:
0 - (por defecto) el reporte aún no ha sido procesado;
1 - el reporte fue generado y enviado exitosamente a todos los destinatarios;
2 - la generación del reporte falló; "info" contiene información del error;
3 - el reporte fue generado, pero el envío a algunos (o todos) los destinatarios falló; "info" contiene información del error.

Comportamiento de la propiedad:
- solo lectura
lastsent timestamp Timestamp Unix del último reporte enviado exitosamente.

Comportamiento de la propiedad:
- solo lectura
info string Descripción del error o información adicional.

Comportamiento de la propiedad:
- solo lectura

Usuarios

El objeto usuarios tiene las siguientes propiedades:

Propiedad Tipo Descripción
userid ID ID del usuario al que se enviará el informe.

Comportamiento de la propiedad:
- obligatorio
access_userid ID ID del usuario en cuyo nombre se generará el informe.

0 - (por defecto) Generar informe por destinatario.
exclude integer Si se debe excluir al usuario de la lista de correo.

Valores posibles:
0 - (por defecto) Incluir;
1 - Excluir.

Grupos de usuarios

El objeto de grupos de usuarios tiene las siguientes propiedades:

Propiedad Tipo Descripción
usrgrpid ID ID del grupo de usuarios al que se enviará el informe.

Comportamiento de la propiedad:
- obligatorio
access_userid ID ID del usuario en cuyo nombre se generará el informe.

0 - (por defecto) Generar informe por destinatario.