Ir al contenido

QueryReport

Genera en el momento un informe de consulta y devuelve sus filas en JSON, o el archivo del informe en el formato del informe. Otro sistema lo usa para obtener los datos del informe cuando los necesita, en lugar de recibir el informe por correo electrónico, por FTP o por POST a una API. Para una suscripción de un informe avanzado, use AdvReport.

Solo se puede obtener un informe que tenga API Access en Yes. La página del informe muestra este ajuste; lo define el soporte de TrakIT. Para preparar un informe para la API, consulte Obtener un informe a través de la API.

Cómo enviar la clave y leer la respuesta: Claves de API, Respuestas.

GET /api/public/QueryReport?APIKey=your-api-key&RepID=your-report-id&Params=2026-10-01;2026-10-31&AsFile=false

Envíe la clave en el parámetro APIKey de la cadena de consulta. La clave debe tener permiso para obtener informes de consulta (qrep.getreport); lo configura el soporte de TrakIT. Codifique para URL todos los valores. La clave forma parte de la dirección, así que no incluya estas URL en los registros que comparta.

Parámetro Obligatorio Significado
APIKey Sí La clave de API.
RepID Sí El identificador del informe, en la forma codificada que TrakIT usa en sus direcciones: la parte que sigue a qrep- en la dirección de la página del informe. El soporte de TrakIT también puede indicárselo junto con la clave. El identificador codificado es distinto cada vez que se abre la página; cualquiera de ellos sirve.
Params No Nuevos valores para los parámetros del informe, separados por ;: un valor por parámetro, en el orden de la pestaña Parameters del informe. Omítalo para ejecutar el informe con los valores que ya tiene.
AsFile No true para obtener el archivo del informe, false para obtener las filas en JSON. El valor predeterminado es false.

APIKey y RepID deben estar en la cadena de consulta: si falta alguno, TrakIT responde con HTTP 404.

Cuando envía Params, TrakIT comprueba cada valor con su parámetro, guarda los valores que han cambiado como valores de los parámetros del informe y después genera el informe. Cada valor debe ser adecuado para su parámetro, como en la pestaña Parameters del informe:

  • un parámetro numérico admite un número de hasta 18 caracteres;
  • un parámetro de fecha admite una fecha: envíela como yyyy-MM-dd (consulte Fechas y horas);
  • un parámetro con una lista admite uno de los elementos de la lista, escrito exactamente como en la lista;
  • cualquier valor tiene hasta 500 caracteres, sin texto que parezca HTML.
Regla Info si no se cumple
APIKey no está vacío. API Key is missing
La clave está activa y tiene permiso para obtener informes de consulta. Key is disabled, not recognized or permission denied
RepID no está vacío. RepID is missing
RepID es un identificador de informe. Invalid RepID
El informe existe. Vacío, con Code 0
El informe tiene API Access. Report not enabled for API access
Params tiene un valor por cada parámetro del informe. Parameters passed do not match the number of parameters in the report
Un parámetro numérico recibe un número de hasta 18 caracteres. Params ... must be numeric, Params ... value too big, con la posición del parámetro, por ejemplo Params 2 must be numeric
Un parámetro de fecha recibe una fecha. Params ... is invalid Date
Un parámetro con una lista recibe uno de sus elementos. Params ... value does not belongs to the allowed list
Un valor tiene hasta 500 caracteres y ningún texto que parezca HTML. Query Parameters seguido de Value cannot exceed 500 characters o Value contains possible html tags or disallowed text
El informe no se está generando ya, por un usuario, un envío programado u otra llamada. Report generation is already in progress (started ...). Please try again shortly.
La consulta del informe devuelve filas, o el informe tiene Generate Empty Report activado. Nothing to export

Si la consulta del informe falla, Code es -1.

La respuesta depende de AsFile. En ambos casos, una solicitud rechazada o fallida recibe el sobre JSON habitual, con Code 0 o -1 y el motivo en Info.

Sin AsFile, o con AsFile=false, una respuesta correcta no es el sobre: es la propia lista de filas, un objeto por fila, con los nombres de las columnas del informe. Compruebe si la respuesta es una lista o un objeto antes de leerla.

[
{
"JobRef": "EXL-2610-0042",
"Customer": "Example Shipping Co",
"Containers": 3,
"LastEventDate": "2026-10-19T14:20:00"
},
{
"JobRef": "EXL-2610-0043",
"Customer": "Example Logistics Ltd",
"Containers": 1,
"LastEventDate": null
}
]
  • Las columnas y sus nombres son los del informe: pregunte a quien configuró el informe.
  • Los valores llegan tal como los devuelve la consulta, sin los formatos de número y de fecha del archivo del informe. Las fechas no tienen zona horaria: consulte Fechas y horas.
  • Un informe con varias tablas solo devuelve su primera tabla. Use AsFile=true para obtenerlas todas.
  • Con Generate Empty Report activado y sin filas, la lista está vacía.

Con AsFile=true, una respuesta correcta es el archivo del informe, generado de la misma forma que la vista previa del informe. Un rechazo es JSON, así que distinga uno de otro por el Content-Type:

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="Open jobs_2610201430.xlsx"

El nombre del archivo es el título del informe, seguido de la fecha y la hora en UTC con el formato yyMMddHHmm y de la extensión del Report Type del informe:

Report Type Archivo
Comma Separated Values (.csv) .csv
HTML File (.html), HTML In Email .htm, el informe como página HTML
Excel Spreadsheet (.xlsx) .xlsx
Text File (.txt) .txt, con el mismo contenido que el archivo CSV
JSON File (.json) .json: la lista de filas o, para un informe con varias tablas, un objeto por tabla, con su title y sus rows
  • Cada llamada que llega a generar el informe aparece en la cola de informes, con API Call como modo de entrega.
  • La llamada responde una vez generado el informe, lo que tarda lo mismo que una vista previa del informe. Téngalo en cuenta en el tiempo de espera de su cliente.
  • Un informe no se puede generar dos veces al mismo tiempo. Si sus llamadas pueden solaparse entre sí, con una vista previa o con un envío programado del mismo informe, vuelva a intentarlo tras una breve espera cuando reciba Report generation is already in progress.