TRtrytoku
Reports

Verificar viabilidad de Report

Changed on

Indica si el reporte de la entidad indicada puede generarse con los filtros solicitados.

Estima la viabilidad a partir de las ejecuciones anteriores del mismo reporte con filtros equivalentes: si esas ejecuciones fallaron por volumen, la respuesta advierte que esta también fallaría. Permite avisar antes de iniciar una generación que no va a completarse.

Un is_viable en true no garantiza el éxito de la generación; solo indica que no hay antecedentes que la descarten.

post/reports/{entity}/viability

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/reports/{entity}/viability
  • 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

Response

Successful Response

is_viableboolean required

Changes