TRtrytoku
Reports

Generar parte de reporte

Changed on

Genera una de las partes en que se divide un reporte grande y la exporta a un archivo Excel.

Transforma los bloques asignados a la parte y deja el archivo resultante en almacenamiento; la respuesta indica dónde quedó y cuántas filas aportó cada hoja.

Responde 422 cuando la parte no produjo datos: es un resultado determinista, así que reintentarla no cambia nada y conviene continuar con las partes restantes.

post/reports/{entity}/generate-part

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/reports/{entity}/generate-part
  • Auth
    API key in header x-api-key

Path parameters

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.

Entidad sobre la que se genera el reporte.

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.

excluded_fieldsstring[]
external_emailsstring[]

Additional email addresses to receive the report (optional). Combined with user_email for notification.

header_metadataobject
include_metadata_headerboolean
include_soft_deletedboolean
part_indexinteger required
report_execution_idstring required
target_storage_prefixstring required
timezonestring
timezone_offsetinteger
total_partsinteger required
user_emailstring

Response

Successful Response

part_indexinteger required
sheet_statsobject

Changes