Export API Endpoints

ETL Export Versions

VersionPathFormatTypeDescriptionPlatformStatus
/v1/v1/{datasetId}/etlExportJSONSynchronousStreams dataset content directly. Not suitable for large datasets.Big Data/Citus
/v2/v2/etlExport/{datasetId}JSONSynchronousInternal improvement of v1.Big Data/CitusReplaced by v3
/v3/v3/etlExport/{datasetId}JSONAsynchronousIntroduced job-based export.Big Data/Citus
/v4/v4/etlExport/{datasetId}ZIP (CSV)AsynchronousExports an entire dataset asynchronously as a ZIP archive containing one CSV file per table.
Supports large datasets and includes an option to export attachments.
Big DataRecommended – DLT2 harvesting
/v5/v5/etlExport/{datasetId}ZIP (Parquet)AsynchronousExports dataset in Parquet format.Analytics-focused.Big DataOptional

Example

GET /v4/etlExport/{datasetId}

Parameters

NameTypeRequiredDescription
datasetIdLongYesID of the dataset to export.
dataflowIdLongYesID of the associated dataflow.
providerIdLongOptionalID of the data provider.
tableSchemaIdStringOptionalRestrict export to a specific table schema.
includeAttachmentsBooleanOptionalInclude attachments in the exported ZIP (default: false).

Response

{
  "pollingUrl": "/orchestrator/jobs/pollForJobStatus/{jobId}?datasetId={datasetId}&dataflowId={dataflowId}",
  "status": "Preparing file"
}

Description

  • When mimeType=csv or zip(with csv files), the export streams data directly as a file download – recommended for large datasets.
  • When using xlsx, validation or formatting may be applied.

The export runs in the background.
Clients (like DLT2) should:

  1. Call the endpoint.
  2. Poll the pollingUrl until job status becomes FINISHED. For more info https://help.reportnet.europa.eu/poll-for-job-status/
  3. Download the resulting ZIP from the orchestrator’s job results.

Output

  • ZIP archive containing one CSV per dataset table.
  • Attachments (if requested) are included in separate folders.

Limitations and Notes

  1. Synchronous vs Asynchronous:
    • /v4 and /v5 are asynchronous and suitable for automated harvesting.
    • /v1 and /v2 are synchronous, best for on-demand downloads.
  2. Authorization:
    • Access depends on the user’s dataset role (CUSTODIAN, STEWARD, OBSERVER, etc.) or API key –header ‘Authorization: ApiKey xxxxx-xxxx-xxxxx’.
  3. Performance:
    • /v1/v3 may fail or time out on large datasets. Use /v4 for all harvesting operations.
  4. Attachments:
    • Only /v4 and /v5 support attachment export.
  5. Formats:
    • /v4 → CSV (archived in ZIP)
    • /v5 → Parquet

Final Recommendation for DLT2

Use:

GET /v4/etlExport/{datasetId}?dataflowId={dataflowId}
  • Handles all dataset sizes.
  • Asynchronous job-based process.
  • Returns ZIP with CSVs (attachments optional).
  • Backward compatible and actively supported.

Dataset – Available Export Endpoints Overview as used in Reportnet 3 UI

EndpointTypeFormatDescriptionRecommended Use
/{datasetId}/exportDatasetFile?mimetype=AsynchronousCSV, XLSX, ZIPExports a dataset directly for download.Manual or quick dataset export with Bearer Token
/{datasetId}/exportDatasetFileDL?mimetype=AsynchronousZIP (CSV)Exports a zip with Csv for each tableManual or quick dataseTablet export with Bearer Token

Requests

1. GET {datasetId}/exportDatasetFile

Exports the entire dataset directly.
Used mainly for user-initiated downloads via the RN3 interface.

Example

GET /exportDatasetFile/1001?mimeType=csv

Parameters

NameTypeRequiredDescription
datasetIdLongYesDataset identifier.
mimeTypeStringYesOutput format (csv, xlsx, zip, etc.).

2. GET {datasetId}/exportDatasetFileDL

Exports the entire dataset directly (synchronous call).
Used mainly for user-initiated datalake downloads via the RN3 interface.

Description

  • zip(with csv files), the export streams data directly as a file download – recommended for large datasets.

Example


GET /exportDatasetFileDL/1001?mimeType=zip+csv

Parameters

NameTypeRequiredDescription
datasetIdLongYesDataset identifier.
mimeTypeStringYesOutput format ZIP of CSV only

Table – Available Export Endpoints Overview as used in Reportnet 3 UI

EndpointTypeFormatDescriptionRecommended Use
/exportFileAsynchronousCSV, XLSXExports a single table from a dataset.Table-level manual export with Bearer Token
/exportFileDLAsynchronousCSVExports a single table from a dataset.Table-level manual export with Bearer Token

Requests

1. POST /exportFile

Exports data for a single table within a dataset.

Parameters

NameTypeRequiredDescription
datasetIdLongYesDataset identifier.
tableSchemaIdStringYesIdentifier of the specific table schema.
mimeTypeStringYesOutput format (csv, xlsx).
Request BodyExportFilterVOOptionalFilters for rows, columns, or specific conditions.

Description

  • Returns the selected table as a downloadable file in the requested format.
  • Useful for manual exports or debugging single tables.
  • The export can be filtered using the ExportFilterVO body.

Example

POST /exportFileDL?datasetId=1001&tableSchemaId=5cf0e9b3b793310e9ceca190&mimeType=csv

Request Body – optional

{
  "filterField": "country",
  "filterValue": "DK"
}

2. POST /exportFileDL

Exports data for a single table within a dataset.

Parameters

NameTypeRequiredDescription
datasetIdLongYesDataset identifier.
tableSchemaIdStringYesIdentifier of the specific table schema.
mimeTypeStringYesOutput format (csv, xlsx).
Request BodyExportFilterVOOptionalFilters for rows, columns, or specific conditions.

Description

  • Returns the selected table as a downloadable file in the requested format.
  • Useful for manual exports or debugging single tables.
  • The export can be filtered using the ExportFilterVO body.

Example

POST /exportFileDL?datasetId=1001&tableSchemaId=5cf0e9b3b793310e9ceca190&mimeType=csv

Request body – optional:

{
  "filterField": "country",
  "filterValue": "DK"
}

Scroll to Top