Skip to main content

Exports Get

Metodo HTTP: GET

Exports Get

A single export by id, with the parameters it was requested with. Poll it to follow the generation. Reserved to administrators.

Path Parameters
  • export_id Export Id required
Responses

200

OK

application/json

403

SchemaExample (from schema)

404

Schema
  • 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.

  • ]
error_code object

An enumeration.

error_message Error Message

Details of the failure. Null when it did not fail.

script Script

Post-processing script the export ran with. Null when it had none.

download_url Download Url

Address 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.

create_date date-time required

When the export was requested.

update_date date-time required

When the export was last modified.

{
  "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.701Z",
  "download_count": 0,
  "last_download_date": "2026-11-19T14:04:06.701Z",
  "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.701Z",
  "update_date": "2026-11-19T14:04:06.701Z"
}

Forbidden

application/jsonSchemaExample (from schema)
Schema
  • detail Detail required

    Why the request was refused.

{
  "detail": "string"
}

Not Found

application/jsonSchemaExample (from schema)
Schema
  • detail Detail required

    Why the request was refused.

{
  "detail": "string"
}
Loading...

Fonte: https://dev.riseact.org/docs/rest-references/riseact-app-exports-rest-api-exports-get. Copia automatica da dev.riseact.org: non modificare qui, le modifiche vanno fatte sulla documentazione Docusaurus.