Saltar al contenido principal

Crear una exportación asíncrona

Crear una exportación asíncrona

POST 

/exports

Permisos requeridos

API Keys: necesitas al menos uno de estos permisos.

  • exports.api.write
  • exports.api.manage

Crea una exportación asíncrona para recursos de alto volumen. La respuesta retorna el estado inicial del proceso y un identificador para consultar su progreso. Al finalizar se emiten los eventos export.completed o export.failed hacia los webhooks suscritos. Para dividir el resultado en un .zip con partes CSV/JSON numeradas y manifest.json, envía packaging: "zip". Sin ese parámetro, download_url conserva el formato CSV/JSON solicitado. Cada recurso requiere además su permiso de lectura: consent.api.read para consent_actions y consent_commits; consent_form_entries.api.read para consent_form_entries; validation_attempts.api.read para validation_attempts; disclosure_requests.api.read (o disclosure.api.read / disclosure.api.manage) para disclosure_requests; y agreements.api.read para agreements y evidences.

El request body acepta resource, report_kind, output_format, packaging, where y order_by.

Prueba este endpoint

Responses

Exportación encolada