Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reports
Publisher Documents
Reporting
Export & Automations
    Automations
    Tabular export
    Visual export
    Raw export
    Slides export
    Report export
      (EXPERIMENTAL) Create document export requestpost(EXPERIMENTAL) Retrieve exported documentget(EXPERIMENTAL) Retrieve document export metadataget(EXPERIMENTAL) Create report export requestpost(EXPERIMENTAL) Retrieve exported filesget(EXPERIMENTAL) Retrieve metadata contextget
    Export Definitions
    Image export
    Export templates
AI Lake
AI Assistant
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Report export

Endpoint:/

(EXPERIMENTAL) Create document export request

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

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

  • workspaceIdstring · required

(EXPERIMENTAL) Create document export request › Headers

  • X-Gdc-Debugboolean
    Default: false

(EXPERIMENTAL) Create document export request › Request Body

  • fileNamestring · required

    File name to be used for retrieving the pdf document.

    Example: filename
  • formatstring · enum · required

    Requested resulting file type.

    Enum values:
    PDF
    Example: PDF
  • documentIdstring

    Document identifier; the export renders the Publisher document page.

    Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
  • metadataobject | null · maxLength: 15000

    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
  • reportIdstring · deprecated · required

    Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'.

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

(EXPERIMENTAL) Create document export request › Responses

Document export request created successfully.

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

(EXPERIMENTAL) Retrieve exported document

GET
/api/v1/actions/workspaces/{workspaceId}/export/document/{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 document › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

(EXPERIMENTAL) Retrieve exported document › Responses

Binary export result.

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

(EXPERIMENTAL) Retrieve document export metadata

GET
/api/v1/actions/workspaces/{workspaceId}/export/document/{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/document endpoint. The metadata structure is not verified.

(EXPERIMENTAL) Retrieve document export metadata › path Parameters

  • workspaceIdstring · required
  • exportIdstring · required

(EXPERIMENTAL) Retrieve document export metadata › Responses

Json metadata representation

No data returned
GET /api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata
deprecated

(EXPERIMENTAL) Create report export request

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

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

  • workspaceIdstring · required

(EXPERIMENTAL) Create report export request › Headers

  • X-Gdc-Debugboolean
    Default: false

(EXPERIMENTAL) Create report export request › Request Body

  • fileNamestring · required

    File name to be used for retrieving the pdf document.

    Example: filename
  • formatstring · enum · required

    Requested resulting file type.

    Enum values:
    PDF
    Example: PDF
  • documentIdstring

    Document identifier; the export renders the Publisher document page.

    Example: 761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0
  • metadataobject | null · maxLength: 15000

    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
  • reportIdstring · deprecated · required

    Document identifier; the export renders the Publisher report page. Deprecated. 'documentId' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with 'documentId'.

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

(EXPERIMENTAL) Create report export request › Responses

Report export request created successfully.

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

(EXPERIMENTAL) Retrieve exported files

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

Deprecated, use getDocumentExport. 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/report/{exportId}
deprecated

(EXPERIMENTAL) Retrieve metadata context

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

Deprecated, use getDocumentExportMetadata. 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/report 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/report/{exportId}/metadata
Slides exportExport Definitions