Export

Description

Export a dashboard. The response can be passed to the import endpoint to recreate the dashboard in another team or tenant.

Request

HTTP Method: GET

Path Parameter Description
id The ID of the dashboard to export. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/dashboards/<<id>>/export \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object representing the dashboard in exported form.

Field description

Parameter Description
schema_version The version of the export schema format.
export_type The type of the export, "dashboard".
exported_at ISO 8601 timestamp representing when the export was generated.
dashboard Object containing the dashboard configuration.

Sample response

{
  "schema_version": 1,
  "export_type": "dashboard",
  "exported_at": "2025-02-10T12:30:45Z",
  "dashboard": {
    "name": "Security overview",
    "notes": [
      {
        "id": "a1b2c3d4e5f6",
        "name": "Welcome note",
        "content": "This dashboard shows key security metrics."
      }
    ],
    "case_lists": [
      {
        "id": "b2c3d4e5f6a1",
        "name": "Open cases",
        "type": "cases",
        "color_palette": "default",
        "filters": {},
        "options": {}
      }
    ],
    "record_charts": [
      {
        "id": "c3d4e5f6a1b2",
        "name": "Priority breakdown",
        "record_type_name": "Cases",
        "element_type": "chart",
        "axes": [
          {
            "direction": "x",
            "record_field_name": "priority"
          }
        ],
        "aggregation": "COUNT",
        "rolling_date_range": null,
        "range_start": null,
        "range_end": null,
        "filters": {
          "stories": [],
          "fields": [
            {
              "value": "open",
              "operator": "equals",
              "name": "status"
            }
          ]
        },
        "order": {
          "field": null,
          "direction": null
        },
        "color_palette": "default",
        "options": {},
        "record_fields": [],
        "test_mode": false
      }
    ],
    "layout": [
      {
        "i": "a1b2c3d4e5f6",
        "x": 0,
        "y": 0,
        "w": 12,
        "h": 2
      },
      {
        "i": "b2c3d4e5f6a1",
        "x": 0,
        "y": 2,
        "w": 6,
        "h": 4
      },
      {
        "i": "c3d4e5f6a1b2",
        "x": 6,
        "y": 2,
        "w": 6,
        "h": 4
      }
    ]
  }
}
Was this helpful?