Dashboard Exports

Export a dashboard as PNG or PDF

Changed on
post/api/v1/deployments/{deploymentId}/dashboard-exports

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/dashboard-exports
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required

Numeric id of the deployment that owns the dashboard.

Request body

dashboardIdinteger nullable

Numeric id of the dashboard to export. Provide either this or dashboardPublicId, not both.

dashboardPublicIdstring nullable

Public id of the dashboard to export. Provide either this or dashboardId, not both.

format'png' | 'pdf' required
layout'screenshot' | 'print'

Response

expiresAtstring date-time required

When the job (and its rendered file) is evicted from the renderer cache. Download before this, or submit a new export.

jobIdstring required

Job id to poll for status and to download the finished file with.

Changes

  • adc4919489f4Revision changes
    • info

      added the new in_month enum value to the request property ///////

    • info

      added the new in_quarter enum value to the request property ///////

    • info

      added the new in_year enum value to the request property ///////

    • info

      added the new not_in_month enum value to the request property ///////

    • info

      added the new not_in_quarter enum value to the request property ///////

    • info

      added the new not_in_year enum value to the request property ///////

  • 56a60219ff2cRevision changes
    • info

      added the new optional request property