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

Tabular export (3.51)

Endpoint:/

(EXPERIMENTAL) Create dashboard tabular export request

POST
/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular

Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular 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 dashboard tabular export request › path Parameters

  • workspaceIdstring · required
  • dashboardIdstring · required

(EXPERIMENTAL) Create dashboard tabular export request › Request Body

  • fileNamestring · required

    Filename of downloaded file without extension.

    Example: result
  • formatstring · enum · required

    Requested tabular export type.

    Enum values:
    XLSX
    PDF
    Example: XLSX
  • dashboardFiltersOverrideobject[]

    List of filters that will be used instead of the default dashboard filters.

  • dashboardTabsFiltersOverridesobject

    Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.

  • settingsobject

    Additional settings.

  • widgetIdsstring[] · maxItems: 1 · unique

    List of widget identifiers to be exported. Note that only one widget is currently supported.

(EXPERIMENTAL) Create dashboard tabular export request › Responses

Tabular export request created successfully.

  • exportResultstring · required
POST /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular

Create tabular export request

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

An tabular 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.

Create tabular export request › path Parameters

  • workspaceIdstring · required

Create tabular export request › Request Body

  • fileNamestring · required

    Filename of downloaded file without extension.

    Example: result
  • formatstring · enum · required

    Expected file format.

    Enum values:
    CSV
    XLSX
    HTML
    PDF
    Example: CSV
  • customOverrideobject

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

  • executionResultstring

    Execution result identifier.

    Example: ff483727196c9dc862c7fd3a5a84df55c96d61a4
  • metadataobject | null · maxLength: 15000

    Free-form JSON object

    Example: {}
  • relatedDashboardIdstring

    Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.

    Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
  • settingsobject

    Additional settings.

  • visualizationObjectstring

    Visualization object identifier. Alternative to executionResult property.

    Example: f7c359bc-c230-4487-b15b-ad9685bcb537
  • visualizationObjectCustomFiltersobject[]

    Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.

    Example: [{"negativeAttributeFilter":{"displayForm":{"identifier":{"id":"products.category","type":"label"}},"notIn":{"values":["Books"]}}}]

Create tabular export request › Responses

Tabular export request created successfully.

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

Retrieve exported files

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

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.

Retrieve exported files › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

Retrieve exported files › Responses

Binary export result.

string
GET /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}
AutomationsVisual export