report

Exportar relatorio em PDF/Excel via webhook (padrao de integracao)

PADRAO DE INTEGRACAO, use quando voce esta ajudando um desenvolvedor a implementar integracao programatica com o Gyra+. Para um usuario apenas exportando no chat, use export_report_and_wait.

Solicita a geracao de PDF/Excel de um relatorio. Processamento assincrono: retorna imediatamente com { status: "processing", reportId } e o arquivo e entregue via webhook configurado pelo cliente (create_webhook).

Use quando:

  • O cliente ja tem (ou esta implementando) um endpoint pra receber webhook.
  • Precisa processar muitos relatorios em lote.
  • Latencia nao e critica e o webhook fecha o ciclo.

Para fluxo interativo de agente (sem webhook), prefira export_report_and_wait. Para chamada bloqueante direta (cliente HTTP suporta long timeout), use export_report_sync.

get/report/export/{id}

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/report/export/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

ID do relatorio a exportar.

Query parameters

type'REPORT' | 'REPORT_MINIFIED' required

Obrigatorio. Use REPORT. Sem ele, a resposta e 400.

exportFormat'pdf' | 'excel' | 'both'

pdf (padrao), excel ou both. Com both saem dois arquivos e dois webhooks.

sectionOrderstring[]

Secoes do arquivo, na ordem desejada. Repita o parametro para cada secao. Sem ele, valem as secoes e a ordem do modelo.

templateIdstring

ID de um modelo de exportacao da organizacao.

systemTemplate'COMPLETE' | 'COMPACT'

Modelo nativo de exportacao.

Response

Objeto { status: "processing", reportId }. O arquivo chega pelo webhook REPORT_EXPORTED.

statusstring

processing: o arquivo chega pelo webhook REPORT_EXPORTED.

reportIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.