Create a New Dashboard for an Organization

POST /api/0/organizations/{organization_id_or_slug}/dashboards/

Create a new dashboard for the given Organization

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

Body Parameters

title (string)
REQUIRED

The user defined title for this dashboard.

id (string)

A dashboard's unique id.

widgets (array(object))

A json list of widgets saved in this dashboard.

projects (array(integer))

The saved projects filter for this dashboard.

environment (array(string))

The saved environment filter for this dashboard.

period (string)

The saved time range period for this dashboard.

start (string)

The saved start time for this dashboard.

end (string)

The saved end time for this dashboard.

filters (object)

The saved filters for this dashboard.

utc (boolean)

Setting that lets you display saved time range for this dashboard in UTC.

permissions

Permissions that restrict users from editing dashboards

Scopes

<auth_token> requires one of the following scopes:
  • org:admin
  • org:read
  • org:write
Copied
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/dashboards/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
Copied
{
  "id": "1",
  "title": "Dashboard",
  "dateCreated": "2024-06-20T14:38:03.498574Z",
  "createdBy": {
    "id": "1",
    "name": "Admin",
    "username": "admin",
    "email": "admin@sentry.io",
    "avatarUrl": "www.example.com",
    "isActive": true,
    "hasPasswordAuth": true,
    "isManaged": false,
    "dateJoined": "2021-10-25T17:07:33.190596Z",
    "lastLogin": "2024-07-16T15:28:39.261659Z",
    "has2fa": true,
    "lastActive": "2024-07-16T20:45:49.364197Z",
    "isSuperuser": false,
    "isStaff": false,
    "experiments": {},
    "emails": [
      {
        "id": "1",
        "email": "admin@sentry.io",
        "is_verified": true
      }
    ],
    "avatar": {
      "avatarType": "letter_avatar",
      "avatarUuid": null,
      "avatarUrl": "www.example.com"
    }
  },
  "widgets": [
    {
      "id": "658714",
      "title": "Custom Widget",
      "description": null,
      "displayType": "table",
      "thresholds": null,
      "interval": "5m",
      "dateCreated": "2024-07-16T15:36:46.048343Z",
      "dashboardId": "1",
      "datasetSource": "user",
      "queries": [
        {
          "id": "1",
          "name": "",
          "fields": [
            "avg(transaction.duration)",
            "transaction"
          ],
          "aggregates": [
            "avg(transaction.duration)"
          ],
          "columns": [
            "transaction"
          ],
          "fieldAliases": [
            "",
            ""
          ],
          "conditions": "",
          "orderby": "-avg(transaction.duration)",
          "widgetId": "1",
          "onDemand": [
            {
              "enabled": false,
              "extractionState": "disabled:not-applicable",
              "dashboardWidgetQueryId": 1
            }
          ],
          "isHidden": false,
          "selectedAggregate": null
        }
      ],
      "limit": null,
      "widgetType": "discover",
      "layout": {
        "w": 2,
        "y": 0,
        "h": 2,
        "minH": 2,
        "x": 0
      }
    }
  ],
  "projects": [
    1
  ],
  "filters": {},
  "period": "7d",
  "permissions": {
    "is_creator_only_editable": false
  }
}