Import

Description

Import a dashboard. The import data should be obtained from the export endpoint.

Request

HTTP Method: POST

Body Parameter Description
team_id ID of the team to which the dashboard should be added.
data JSON object representing the dashboard in exported form.
mode Optional Create a new dashboard or replace an existing one by name - (new, replace). Defaults to new.
new_name Optional Name for the dashboard. Defaults to the name in the export data. In replace mode, this specifies which existing dashboard to replace. 
curl -X POST \
  https://<<META.tenant.domain>>/api/v1/dashboards/import \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
    "team_id": 14,
    "new_name": "Imported dashboard",
    "mode": "new",
    "data": {
      "schema_version": 1,
      "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
          }
        ]
      }
    }
  }'

Response

A successful request will return a JSON object describing the newly created dashboard with a 201 status code.

Field description

Parameter Description
id The ID of the dashboard.
name Name of the dashboard.
team Object describing the team this dashboard belongs to.
team.id Integer ID of the team.
team.name Name of the team.
created_at ISO 8601 timestamp representing when the dashboard was created.
updated_at ISO 8601 timestamp representing when the dashboard was last updated.

Sample response

{
  "id": 42,
  "name": "Imported dashboard",
  "team": {
    "id": 14,
    "name": "Security Operations"
  },
  "created_at": "2025-02-14T10:30:00Z",
  "updated_at": "2025-02-14T10:30:00Z"
}
Was this helpful?