Create Dashboard

Creates a new dashboard

POST /api/v2/dashboards

Error

simpleTimeSeriesDashboard

A valid request URL is required to generate request examples

200

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "API Monitoring Dashboard",
    "tiles": [
      {
        "id": "65f5e4a3b9e77c001a901234",
        "name": "API Request Volume",
        "x": 0,
        "y": 0,
        "w": 6,
        "h": 3,
        "config": {
          "displayType": "line",
          "sourceId": "65f5e4a3b9e77c001a111111",
          "select": [
            {
              "aggFn": "count",
              "where": "service:api"
            }
          ]
        }
      }
    ],
    "tags": [
      "api",
      "monitoring"
    ],
    "filters": [
      {
        "id": "65f5e4a3b9e77c001a301004",
        "type": "QUERY_EXPRESSION",
        "name": "Environment",
        "expression": "environment",
        "sourceId": "65f5e4a3b9e77c001a111111"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Dashboard name.

Maximum string length: 1024

Example:

"New Dashboard"

tiles · object[] · required

List of tiles/charts to include in the dashboard.

Maximum array length: 500

Show child attributes

tags · string[]

Tags for organizing and filtering dashboards.

Maximum array length: 50

Maximum string length: 32

Example:

["development"]

filters · object[]

Dropdown filters added to the dashboard. Each one broadcasts its selected value as a condition, acts as a variable which can be referenced in tile queries, or both.

Show child attributes

savedQuery · string | null

Optional default dashboard query to persist on the dashboard.

Example:

"service.name = 'api'"

savedQueryLanguage · enum<string> | null · default: lucene

Query language used by savedQuery.

Available options: sql, lucene

Example:

"sql"

savedFilterValues · object[]

Optional default dashboard filter values to persist on the dashboard.

A single saved dashboard filter selection. Either a rendered SQL condition, or a selection addressed by the name of the dashboard variable it belongs to.

Option 1

Option 2

Show child attributes

containers · object[]

Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId.

Maximum array length: 50

Show child attributes

Response

200

application/json

Successfully created dashboard

data · object

The dashboard object.

Show child attributes