Sign in

v1

latestOpenAPI 3.0.02026-07-12152226.1 KB
Dashboards

patchDashboard

Partially update a dashboard by ID. Update content (title/tiles) and/or manage sharing (owners, shared_with, org_access) — only owners may change sharing. owners and shared_with replace the whole array (send the complete list); omit them to leave sharing unchanged, or send shared_with: [] to revoke all per-user grants.

patch/v1/dashboard/dashboards/{id}

Request body

ownersstring[]

Replaces the entire list of owner user ids. Must keep at least one owner (else 400). Omit to leave owners unchanged.

titlestring

Example request

{
  "shared_with": [
    {
      "user_id": "10598",
      "permission": "view"
    }
  ],
  "title": "Employee Dashboard",
  "tiles": [
    {
      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",
      "title": "Number of opportunities created by journeys every month",
      "insight_id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
      "visualisation_id": "timechart",
      "visualisation_config": {
        "query": {
          "dataset": "entity_operations",
          "measure": "count_operations",
          "dimensions": [
            {
              "time_with_granularity": "year-month"
            }
          ],
          "filters": [
            {
              "entity_schema": "opportunity"
            }
          ]
        },
        "options": {
          "type": "bar"
        }
      }
    }
  ]
}

Response

The updated dashboard

created_bystring

Id of the user who created the resource

created_atstring date-time
updated_bystring

Id of the user who last updated the resource

updated_atstring date-time
owner_org_idstring

Id of the organisation that owns the resource. Set at creation time and immutable.

ownersstring[]

User ids with full control over the resource (view, edit, delete and manage sharing). The creator is always an owner. There must always be at least one owner.

idstring uuid

Unique identifier for dashboard

titlestring required

Example response

{
  "created_by": "10598",
  "updated_by": "10598",
  "owner_org_id": "739224",
  "owners": [
    "10598"
  ],
  "shared_with": [
    {
      "user_id": "10598",
      "permission": "view"
    }
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Employee Dashboard",
  "tiles": [
    {
      "id": "e4af1297-1fd6-440f-9846-f475f580d40f",
      "coordinates": {},
      "insight_id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e"
    }
  ]
}