Exports List
Metodo HTTP: GET
Exports List
Exports of the organization, newest first. Reserved to administrators: an export is a bulk extract of personal data and its history is the record of who took it.
Query Parameters
- limit Limit
Possible values:
>= 1Default value:
100 - offset Offset
200
OK
application/jsonSchemaExample (from schema)Schema
items object[]
- Array [
- id Id required
Unique identifier of the export.
- kind object
An enumeration.
- format object
An enumeration.
- state object
An enumeration.
- label Label required
Human-readable name of the export, built from its kind and the moment it ran.
- filename Filename
Name of the generated file. Null until it is ready.
- rows_total Rows Total required
Records written to the file.
- file_size File Size required
Size of the file in bytes.
- expires_date date-time
When the file is deleted. The export itself is kept as history.
- download_count Download Count required
How many times the file has been downloaded.
- last_download_date date-time
When the file was last downloaded.
- attempts Attempts required
How many times the generation was attempted, retries included.
- task_id Task Id
Identifier of the background task generating the file.
- filters object required
The filters the export ran with, copied when it was requested. Empty when it ran over everything.
- from_selection From Selection required
Whether the export ran over an explicit selection of records rather than filters.
- staff_name Staff Name
Name of the staff member who requested the export. Null when it was not started by a person.
- segment_name Segment Name
Name of the saved segment the export ran over. Null when it ran over ad-hoc filters.
fields object[] required
The columns the export was asked to produce, in the order they appear in the file.
- Array [
- key Key required
Identifier of the column, as written in the file header.
- label Label required
Human-readable name of the column. Falls back to the key when the column no longer exists.
- ]
An enumeration.
error_message Error MessageDetails of the failure. Null when it did not fail.
script ScriptPost-processing script the export ran with. Null when it had none.
download_url Download UrlAddress the file is served from with an Authorization: Bearer header. Null when the file is not ready or no longer available. Only administrators of the organization can download it.
When the export was requested.
update_date date-time requiredWhen the export was last modified.
]count Count required{
"items": [
{
"id": 0,
"kind": "SUPPORTERS",
"format": "XLSX",
"state": "PENDING",
"label": "string",
"filename": "string",
"rows_total": 0,
"file_size": 0,
"expires_date": "2026-11-19T14:04:06.699Z",
"download_count": 0,
"last_download_date": "2026-11-19T14:04:06.699Z",
"attempts": 0,
"task_id": "string",
"filters": {},
"from_selection": true,
"staff_name": "string",
"segment_name": "string",
"fields": [
{
"key": "string",
"label": "string"
}
],
"error_code": "FIELDS_INVALID",
"error_message": "string",
"script": "string",
"download_url": "string",
"create_date": "2026-11-19T14:04:06.699Z",
"update_date": "2026-11-19T14:04:06.699Z"
}
],
"count": 0
}Loading...Fonte: https://dev.riseact.org/docs/rest-references/riseact-app-exports-rest-api-exports-list. Copia automatica da dev.riseact.org: non modificare qui, le modifiche vanno fatte sulla documentazione Docusaurus.