Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
    Automations
    Tabular export
    Visual export
    Raw export
      (EXPERIMENTAL) Create raw export requestpost(EXPERIMENTAL) Retrieve exported filesget
    Slides export
    Export Definitions
    Image export
    Export templates
Other
Schemas
powered by Zudoku
OpenAPI definition

Raw export (3.51)

Endpoint:/

(EXPERIMENTAL) Create raw export request

POST
/api/v1/actions/workspaces/{workspaceId}/export/raw

Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.

(EXPERIMENTAL) Create raw export request › path Parameters

  • workspaceIdstring · required

(EXPERIMENTAL) Create raw export request › Request Body

  • executionobject · required

    Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.

  • fileNamestring · required

    Filename of downloaded file without extension.

    Example: result
  • formatstring · enum · required

    Requested resulting file type.

    Enum values:
    ARROW_FILE
    ARROW_STREAM
    CSV
    Example: CSV
  • customOverrideobject

    Custom cell value overrides (IDs will be replaced with specified values).

  • executionSettingsobject

    Various settings affecting the process of AFM execution or its result

(EXPERIMENTAL) Create raw export request › Responses

Raw export request created successfully.

  • exportResultstring · required
POST /api/v1/actions/workspaces/{workspaceId}/export/raw

(EXPERIMENTAL) Retrieve exported files

GET
/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}

Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.

(EXPERIMENTAL) Retrieve exported files › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

(EXPERIMENTAL) Retrieve exported files › Responses

Binary export result.

string
GET /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}
Visual exportSlides export