TRtrytoku
Downloads

Generar reporte descargable

Changed on

Genera un reporte de la entidad indicada y devuelve la URL firmada para descargarlo.

El reporte se construye con los filtros del payload, se sube a almacenamiento y la respuesta trae la URL de descarga junto con dataAvailable, que indica si hubo registros que exportar. Cuando la consulta no arroja datos la URL queda vacía y dataAvailable es false.

Si el payload incluye user_email o external_emails, además se envía el reporte por correo a esas direcciones. La generación es sincrónica: la respuesta llega recién cuando el archivo está listo, así que en reportes de gran volumen la llamada puede tardar varios segundos.

post/download

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/download
  • Auth
    API key in header x-api-key

Request body

custom_paramsobject
date_range'CURRENT_DAY' | 'PREVIOUS_DAY' | 'LAST_WEEK' | 'LAST_7DAYS' | 'CURRENT_MONTH' | 'LAST_MONTH' | 'LAST_30DAYS' | 'LAST_3MONTHS' | 'LAST_12MONTHS'

Rango de fechas relativo a un día de referencia: hoy, salvo que la ejecución indique otro. Los dos extremos son inclusivos.

detail_metadataobject
entity'bank_account_verification' | 'billing' | 'campaign' | 'card_verification' | 'customer' | 'customer_portal_event' | 'interaction_event' | 'invoice' | 'message' | 'payment' | 'payment_v2' | 'payment_intent' | 'payment_method' | 'payout' | 'payout_v2' | 'subscription' | 'ticket' | 'payment_method_inscription_intent' | 'pac_inscription_intent' | 'payout_additional' | 'campaign_customer' | 'campaign_invoice' | 'transfer_cl_activation' | 'electronic_signature_document' | 'chargeback' | 'chargeback_v2' | 'temporary_collection_file' | 'recipient_verification' | 'conversations_ai_agent' | 'forum_notification' | 'payout_disbursement' | 'beneficiary_account' | 'payout_batch' | 'reconciliation' required

Conjunto de datos que se exporta. Cada valor apunta a un reporte distinto, con sus propias columnas y hojas, así que es lo que determina la forma del archivo resultante.

Es un catálogo que crece al publicar reportes nuevos, y no todos los valores están disponibles para toda organización: algunos dependen de sus permisos y otros exigen parámetros adicionales. Los valores terminados en _v2 no son otro formato del mismo reporte, sino una versión que lee un modelo de datos más nuevo, con columnas y hojas distintas.

excludestring[]
external_emailsstring[]
get_soft_deletedboolean
id_campaignstring
include_detailboolean
timezonestring
timezone_offsetinteger
user_emailstring

Response

Successful Response

dataAvailableboolean required

Indica si el reporte contiene datos. Es false cuando la consulta no arrojó registros.

urlstring required

URL firmada de descarga del reporte, con vigencia limitada. Queda vacía cuando no hubo datos que exportar.

Changes