Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
    Automations
    Tabular export
    Visual export
      Create visual - pdf export requestpostRetrieve exported filesgetRetrieve metadata contextget
    Raw export
    Slides export
    Export Definitions
    Image export
    Export templates
AI Lake
AI Assistant
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Visual export

Endpoint:/

Create visual - pdf export request

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

An visual 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 visual - pdf export request › path Parameters

  • workspaceIdstring · required

Create visual - pdf export request › Headers

  • X-Gdc-Debugboolean
    Default: false

Create visual - pdf export request › Request Body

  • dashboardIdstring · required

    Dashboard identifier

    Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
  • fileNamestring · required

    File name to be used for retrieving the pdf document.

    Example: filename
  • metadataobject

    Metadata definition in free-form JSON format.

    Example: {}
  • timezoneIdstring | null

    Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.

    Example: Asia/Kolkata

Create visual - pdf export request › Responses

Visual export request created successfully.

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

Retrieve exported files

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

Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.

Retrieve exported files › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

Retrieve exported files › Responses

Binary export result.

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

Retrieve metadata context

GET
/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata

This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.

Retrieve metadata context › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

Retrieve metadata context › Responses

Json metadata representation

No data returned
GET /api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata
Tabular exportRaw export