ReportHistory

Seguimiento de la generación asíncrona de un reporte descargable. Al pedir un reporte pesado se crea una fila que va avanzando de estado hasta quedar disponible para descarga.

  • name: Nombre del reporte (derivado de report_url).
  • download_link: ruta para descargar el reporte generado cuando status == available.
  • progress: progreso de la generación de 0.00 a 100.00 (inclusive). Al llegar a 100 puede tardar unos segundos en pasar a status = available mientras se sube el archivo.

Estados (status)

in_queue (en cola) → generating (generándose, ver progress) → available (listo, download_link disponible) o failed (falló la generación).

Estructura de Datos

Atributo Tipo Descripción
id int
report_url string Endpoint del reporte solicitado.
args array Parámetros con los que se pidió el reporte (rango de fechas, filtros, ...).
download_link string Ruta de descarga del archivo; sólo con status = available.
status string Estado de la generación: in_queue, generating, available o failed.
account_id int ID de la cuenta que pidió el reporte.
company_id int Compañía a la que pertenece el reporte (oculto en la respuesta).
created_at datetime\|null Fecha de la solicitud.
updated_at datetime\|null Fecha de la última actualización de estado/progreso.
progress float Progreso de la generación, de 0.00 a 100.00.
allLogs ApiLog> Registros de auditoría de la API, incluidos los internos.
author Admin Administrador que pidió el reporte.
logs ApiLog> Registros de auditoría de la API visibles.
name string Nombre del reporte, derivado de report_url. 
{
    "id": 3,
    "report_url": "api/v3/companies/116/reports/company-orders",
    "args": {
        "parameters": {
            "company_id": 116,
            "beg": "2025-04-21T04:00:00.000000Z",
            "end": "2025-04-24T03:59:59.000000Z",
            "tz": "-04:00"
        },
        "payload": []
    },
    "download_link": "https://dondemand-dev.sfo3.cdn.digitaloceanspaces.com/companies/69/reports/órdenes_general_1745431662.xlsx",
    "status": "available",
    "account_id": 175,
    "created_at": "2025-04-23 18:07:42",
    "updated_at": "2025-04-23 18:46:44",
    "progress": 100,
    "name": "company-orders",
    "author": {
        "id": 96,
        "name": "Pedro Parra",
        "display_name": "admin_175",
        "email": "pedrop@manzanares.com.ve",
        "phone": "584121198667",
        "avatar_url": "http://127.0.0.1:8000/storage/static/default/avatar_admin.png",
        "status": 0,
        "created_at": "2020-04-20 15:24:38",
        "updated_at": "2026-08-07 23:46:30",
        "deleted_at": null,
        "account_id": 175,
        "admin_type_id": null,
        "city_id": 17,
        "is_status_online": false,
        "settings": {
            "preferences": {
                "audible_notifications.branch_in_service": "on",
                "audible_notifications.order_new": "off",
                "audible_notifications.payment_new": "off",
                "audible_notifications.order_being_prepared": "on",
                "audible_notifications.order_accepted": "off",
                "audible_notifications.order_prepared": "on",
                "audible_notifications.liver_arrived": "on",
                "audible_notifications.liver_in_commerce": "on",
                "audible_notifications.liver_on_the_way": "on",
                "audible_notifications.order_arrived": "off",
                "audible_notifications.order_delivered": "off",
                "audible_notifications.order_canceled": "off"
            }
        },
        "admin_type": null
    }
}

Endpoints

Listar ReportHistory

{info} Soporta: Paginación Filters Carga dinámica

Listar reportes generados

Devuelve los ReportHistory de la compañía pedidos por el usuario autenticado, paginados. Sirve para consultar el estado y el download_link de reportes asíncronos.

Método URI Cabeceras
GET /companies/{companyId}/report-histories Authorization

Relaciones