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

Image export (3.51)

Endpoint:/

(EXPERIMENTAL) Create image export request

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

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

  • workspaceIdstring · required

(EXPERIMENTAL) Create image export request › Request Body

  • dashboardIdstring · required

    Dashboard identifier

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

    File name to be used for retrieving the image document.

    Example: filename
  • formatstring · enum · required

    Requested resulting file type.

    Enum values:
    PNG
    Example: PNG
  • widgetIdsstring[] · minItems: 1 · maxItems: 1 · unique · required

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

  • metadataobject | null · maxLength: 15000

    Free-form JSON object

    Example: {}

(EXPERIMENTAL) Create image export request › Responses

Image export request created successfully.

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

(EXPERIMENTAL) Retrieve exported files

GET
/api/v1/actions/workspaces/{workspaceId}/export/image/{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/image/{exportId}

(EXPERIMENTAL) Retrieve metadata context

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

Note: This API is an experimental and is going to change. Please, use it accordingly. 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/image endpoint. The metadata structure is not verified.

(EXPERIMENTAL) Retrieve metadata context › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

(EXPERIMENTAL) Retrieve metadata context › Responses

Json metadata representation

No data returned
GET /api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata
Export DefinitionsExport templates