Skip to content

share_dashboard

Generate a time-limited pre-signed URL for a saved dashboard and return an iframe embed snippet. The URL allows anonymous read-only access to the rendered dashboard HTML for the requested duration. Requires at least Viewer access to the project. Returns: dashboard_name (str) — dashboard identifier; project (str) — project name; share_url (str) — pre-signed S3 URL valid for expires_hours; expires_hours (int) — URL validity window in hours; embed_snippet (str) — ready-to-paste HTML iframe element. Requires Pro plan.

NameTypeRequiredDefaultDescription
project_namestrYes
dashboard_namestrYes
expires_hoursintNo24

Returns a structured object. Top-level fields:

  • dashboard_name (string)
  • project (string)
  • share_url (string)
  • expires_hours (integer)
  • embed_snippet (string)

See the response example below for the full payload shape.

{
"name": "share_dashboard",
"arguments": {
"project_name": "forecasts",
"dashboard_name": "ARR Bridge",
"expires_hours": 48
}
}
{
"dashboard_name": "ARR Bridge",
"project": "forecasts",
"share_url": "https://s3.example.com/dashboards/tenant/project/dash.html?X-Amz-Algorithm=...",
"expires_hours": 48,
"embed_snippet": "<iframe\n src=\"https://s3.example.com/dashboards/tenant/project/dash.html?X-Amz-Algorithm=...\"\n title=\"ARR Bridge\"\n width=\"100%\"\n height=\"600px\"\n frameborder=\"0\"\n allowfullscreen\n></iframe>"
}
  • Module: Dashboards
  • Requires authentication via API token or Auth0 JWT.