Consulta de Reportes Generados

A través de la API de Sagicc, podrás consultar y descargar la información de los reportes generados en el Módulo de Reportes de la plataforma. Esto te permitirá acceder a los datos en formato JSON para integrarlos con otros sistemas o importarlos en plataformas externas. Una vez que un reporte (programado o no) haya sido generado y esté disponible para descarga en el listado de reportes, también podrás acceder a su información directamente desde la API.

Para consultar el listado de reportes generados en la plataforma, realiza una petición de tipo GET al siguiente endpoint:

https://{{sagicc_instance_url}}/api/table/reporte_generado?type=normal&conditions=(estado="GENERADO" AND created_at > "2025-01-01" AND tipo_reporte=24)&page=1&sizePerPage=50&sortName=id&sortOrder=desc&enabled=true

Asegúrate de modificar los siguientes parámetros de acuerdo a tus necesidades:

type: Indica el tipo de consulta o la estructura de los registros a obtener. Para consultar los reportes generados, utiliza el valor "normal".
conditions: Permite aplicar filtros a los registros mediante condiciones sobre el modelo y sus relaciones. Algunos filtros útiles para la consulta de reportes generados son:
- estado: Usa el valor "GENERADO" para obtener únicamente los reportes que ya han sido generados y están disponibles para descargar.
- created_at: Permite filtrar por fecha de creación. Puedes utilizar operadores como > o < para definir rangos de fechas.
- tipo_reporte: Especifica el tipo de reporte que deseas obtener filtrando por su identificador.
page: Número de la página de resultados que deseas obtener. Es clave para implementar la paginación correctamente.
sizePerPage: Define la cantidad de registros por página. Este parámetro optimiza la consulta cuando se manejan grandes volúmenes de datos.
sortName: Nombre de la columna por la cual deseas ordenar los resultados.
sortOrder: Orden de los registros basado en el campo sortName. Los valores posibles son "asc" (ascendente) o "desc" (descendente). Usa "desc" para obtener los reportes más recientes primero.

Si la petición se ejecuta exitosamente, la información se obtendrá en formato JSON, y la respuesta devolverá un código 200 junto con un mensaje de éxito. En caso de que la solicitud falle, la respuesta incluirá un código 400 acompañado de un mensaje que detallará la causa del error.

La respuesta exitosa obtenida tendrá la siguiente estructura:

{
    "status": "OK",
    "code": "OMO001",
    "message": "El listado de reporte_generado ha sido obtenido exitosamente.",
    "fullMessage": "OMO001 - El listado de reporte_generado ha sido obtenido exitosamente.",
    "statusResult": true,
    "result": [
        {
            "id": 83,
            "nombre": "Base de Clientes",
            "link_descarga": "/reports/BasedeClientes_1743775050.json",
            "tipo_reporte": 24,
            "reporte_programado_id": null,
            "tipo_generacion": 0,
            "estado": "GENERADO",
            "config_reporte": {
                "features": [],
                "workspace": 1,
                "fecha_desde": "2025-03-01 00:00:00",
                "fecha_hasta": "2025-03-31 23:59:59",
                "filter_field": "created_at",
                "assigned_users": [],
                "ignore_validation": true
            },
            "descargado": 1,
            "habilitado": true,
            "created_at": "2025-04-04 08:57:28",
            "updated_at": "2025-04-11 17:08:32",
            "deleted_at": null,
            "created_by": 44,
            "updated_by": 8,
            "deleted_by": null,
            "workspace_id": 1
        }
    ]
}

Ubica el reporte cuya información deseas descargar y anota su "id". Con este valor, puedes realizar una petición de tipo GET al siguiente endpoint, reemplazando {{id}} por el identificador del reporte correspondiente:

https://{{sagicc_instance_url}}/api/reportes/descargarData/{{id}}

Si la solicitud se ejecuta correctamente, recibirás toda la información del reporte en formato JSON. La estructura de la respuesta incluye los encabezados de las columnas y los datos correspondientes a cada uno de los registros del reporte.

{
    "header": [
        "NRO. CASO",
        "CAMPAÑA",
        "DESCRIPCION CASO",
        "TIPO CASO",
        "ESTADO CASO",
        "FECHA CREACION CASO",
        "FECHA CIERRE CASO",
        "USUARIO CIERRE CASO",
        "TIPO CANAL ORIGEN CASO",
        "TIPO DOCUMENTO",
        "NRO. DOCUMENTO",
        "PRIMER APELLIDO",
        "SEGUNDO APELLIDO",
        "PRIMER NOMBRE",
        "SEGUNDO NOMBRE",
        "ETIQUETA CLIENTE",
        "NRO. CUENTA",
        "TELEFONO",
        "CORREO ELECTRONICO",
        "OBSERVACIONES GESTION",
        "FECHA GESTION",
        "USUARIO GESTION",
        "GRABACIONES",
        "CUMPLIO SLA"
    ],
    "data": [],
    "name": "REPORTE DE GESTIONES"
}

El tamaño del reporte puede afectar el tiempo de respuesta del endpoint. Si el archivo es muy grande, es posible que la descarga tome algunos segundos. Ten paciencia, la información se descargará correctamente.