EPepilot
Dashboards

getDashboard

Changed on

Get dashboard by ID

get/v1/dashboard/dashboards/{id}

Request

  • Base URL
    https://dashboard.sls.epilot.io
  • URL
    https://dashboard.sls.epilot.io/v1/dashboard/dashboards/{id}
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Response

The dashboard with the passed ID

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
favoritedboolean

Whether the requesting user has favorited this dashboard.

versioninteger

Schema version of the dashboard. 1 is a dashboard authored in the classic dashboard UI, 2 in the analytics surface. Omit on create to default to 1. May only move forward: a PUT carrying a higher version upgrades the dashboard (this is how a legacy dashboard is converted), while a lower or absent value leaves the stored version untouched. Ignored on PATCH.

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"
    }
  ],
  "filters": [
    {
      "id": "time_range",
      "kind": "time_range",
      "label": "Zeitraum",
      "default_value": {
        "preset": "last_30_days"
      }
    },
    {
      "id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
      "kind": "dimension",
      "label": "Status",
      "field": "current_opportunities.status",
      "field_type": "string",
      "operator": "in",
      "default_value": [
        "won"
      ]
    }
  ],
  "version": 2
}

Changes

  • 43a3a9a1c8acRevision changes
    • warning

      added the new notes enum value to the /// response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

  • 91d9e23375acRevision changes
    • info

      added the optional property / to the response with the status