Dashboard API
- Base URL:
https://dashboard.sls.epilot.io - Full API Docs: https://docs.epilot.io/api/dashboard
Usageโ
import { epilot } from '@epilot/sdk'
epilot.authorize(() => '<token>')
const { data } = await epilot.dashboard.listDashboards(...)
Tree-shakeable importโ
import { getClient, authorize } from '@epilot/sdk/dashboard'
const dashboardClient = getClient()
authorize(dashboardClient, () => '<token>')
const { data } = await dashboardClient.listDashboards(...)
Operationsโ
Dashboards
listDashboardscreateDashboardlistFavoriteDashboardIdsfavoriteDashboardunfavoriteDashboardgetDashboardputDashboardpatchDashboarddeleteDashboard
Insights
Visualisations
Examples
Schemas
DashboardIDDashboardDashboardTileIDSharePermissionShareGrantOrgAccessAccessControlAccessControlUpdateDashboardPatchInsightIDInsightInsightPatchTagsPaginationDashboardTileVisualisationConfigtimechartVisualisationConfigExampleIDExampleDatalakeQueryVisualisationIdVisualisation
listDashboardsโ
List dashboards available to the user
GET /v1/dashboard/dashboards
const { data } = await client.listDashboards({
q: 'example',
created_by: 'example',
created_after: 'example',
created_before: 'example',
updated_after: 'example',
updated_before: 'example',
shared_with: ['...'],
owner: ['...'],
accessible_to: 'example',
favorite: true,
favorites_first: true,
sort: 'example',
order: 'example',
limit: 1,
offset: 1,
})
Response
{
"results": [
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "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"
}
],
"favorited": false
}
],
"pagination": {
"total": 0,
"limit": 0,
"offset": 0,
"has_more": true
}
}
createDashboardโ
Create new dashboard
POST /v1/dashboard/dashboards
const { data } = await client.createDashboard(
null,
{
created_by: '10598',
created_at: '1970-01-01T00:00:00.000Z',
updated_by: '10598',
updated_at: '1970-01-01T00:00:00.000Z',
owner_org_id: '739224',
owners: ['10598'],
shared_with: [
{
user_id: '10598',
permission: 'view'
}
],
org_access: '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'
}
],
favorited: false
},
)
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "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"
}
],
"favorited": false
}
listFavoriteDashboardIdsโ
Returns the current user's favorited dashboard ids, with no dashboard metadata. Lets a client decide whether to default to a favorites-only view without first fetching the full dashboards list.
GET /v1/dashboard/dashboards/favorites
const { data } = await client.listFavoriteDashboardIds()
Response
{
"dashboard_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
"total": 0
}
favoriteDashboardโ
Marks the dashboard as favorited by the current user. Idempotent โ favoriting an already-favorited dashboard is not an error. Requires only view-level access to the dashboard (unlike the edit-level ch
PUT /v1/dashboard/dashboards/{id}/favorite
const { data } = await client.favoriteDashboard({
id: '123e4567-e89b-12d3-a456-426614174000',
})
unfavoriteDashboardโ
Removes the current user's favorite for the dashboard. Idempotent โ unfavoriting a dashboard that was not favorited is not an error, and neither is unfavoriting one that no longer exists or is no long
DELETE /v1/dashboard/dashboards/{id}/favorite
const { data } = await client.unfavoriteDashboard({
id: '123e4567-e89b-12d3-a456-426614174000',
})
getDashboardโ
Get dashboard by ID
GET /v1/dashboard/dashboards/{id}
const { data } = await client.getDashboard({
id: '123e4567-e89b-12d3-a456-426614174000',
})
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "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"
}
],
"favorited": false
}
putDashboardโ
Update a dashboard by ID
PUT /v1/dashboard/dashboards/{id}
const { data } = await client.putDashboard(
{
id: '123e4567-e89b-12d3-a456-426614174000',
},
{
created_by: '10598',
created_at: '1970-01-01T00:00:00.000Z',
updated_by: '10598',
updated_at: '1970-01-01T00:00:00.000Z',
owner_org_id: '739224',
owners: ['10598'],
shared_with: [
{
user_id: '10598',
permission: 'view'
}
],
org_access: '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'
}
],
favorited: false
},
)
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "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"
}
],
"favorited": false
}
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
PATCH /v1/dashboard/dashboards/{id}
const { data } = await client.patchDashboard(
{
id: '123e4567-e89b-12d3-a456-426614174000',
},
{
owners: ['string'],
shared_with: [
{
user_id: '10598',
permission: 'view'
}
],
org_access: 'view',
title: 'Employee Dashboard',
tiles: [
{
id: 'e4af1297-1fd6-440f-9846-f475f580d40f',
coordinates: {},
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
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "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"
}
],
"favorited": false
}
deleteDashboardโ
Delete a dashboard by ID
DELETE /v1/dashboard/dashboards/{id}
const { data } = await client.deleteDashboard({
id: '123e4567-e89b-12d3-a456-426614174000',
})
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "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"
}
],
"favorited": false
}
listInsightsโ
List insights (saved charts) available to the user
GET /v1/dashboard/insights
const { data } = await client.listInsights({
q: 'example',
visualisation_id: ['...'],
tags: ['...'],
tags_match: 'example',
created_by: 'example',
created_after: 'example',
created_before: 'example',
updated_after: 'example',
updated_before: 'example',
shared_with: ['...'],
owner: ['...'],
accessible_to: 'example',
sort: 'example',
order: 'example',
limit: 1,
offset: 1,
})
Response
{
"results": [
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "view",
"id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
"name": "Opportunities created by journeys every month",
"description": "Monthly count of opportunities grouped by source journey",
"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"
}
},
"tags": ["revenue", "marketing"]
}
],
"pagination": {
"total": 0,
"limit": 0,
"offset": 0,
"has_more": true
}
}
createInsightโ
Create a new insight (saved chart). The caller becomes the owner.
POST /v1/dashboard/insights
const { data } = await client.createInsight(
null,
{
created_by: '10598',
created_at: '1970-01-01T00:00:00.000Z',
updated_by: '10598',
updated_at: '1970-01-01T00:00:00.000Z',
owner_org_id: '739224',
owners: ['10598'],
shared_with: [
{
user_id: '10598',
permission: 'view'
}
],
org_access: 'view',
id: '8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e',
name: 'Opportunities created by journeys every month',
description: 'Monthly count of opportunities grouped by source journey',
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'
}
},
tags: ['revenue', 'marketing']
},
)
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "view",
"id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
"name": "Opportunities created by journeys every month",
"description": "Monthly count of opportunities grouped by source journey",
"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"
}
},
"tags": ["revenue", "marketing"]
}
listInsightTagsโ
List the distinct tags used by insights in the organization (for filter facets)
GET /v1/dashboard/insights/tags
const { data } = await client.listInsightTags()
Response
{
"results": ["string"]
}
getInsightโ
Get insight by ID
GET /v1/dashboard/insights/{id}
const { data } = await client.getInsight({
id: '123e4567-e89b-12d3-a456-426614174000',
})
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "view",
"id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
"name": "Opportunities created by journeys every month",
"description": "Monthly count of opportunities grouped by source journey",
"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"
}
},
"tags": ["revenue", "marketing"]
}
putInsightโ
Replace an insight's content by ID. Sharing is managed via patchInsight.
PUT /v1/dashboard/insights/{id}
const { data } = await client.putInsight(
{
id: '123e4567-e89b-12d3-a456-426614174000',
},
{
created_by: '10598',
created_at: '1970-01-01T00:00:00.000Z',
updated_by: '10598',
updated_at: '1970-01-01T00:00:00.000Z',
owner_org_id: '739224',
owners: ['10598'],
shared_with: [
{
user_id: '10598',
permission: 'view'
}
],
org_access: 'view',
id: '8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e',
name: 'Opportunities created by journeys every month',
description: 'Monthly count of opportunities grouped by source journey',
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'
}
},
tags: ['revenue', 'marketing']
},
)
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "view",
"id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
"name": "Opportunities created by journeys every month",
"description": "Monthly count of opportunities grouped by source journey",
"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"
}
},
"tags": ["revenue", "marketing"]
}
patchInsightโ
Partially update an insight by ID. Update content (name/description/visualisation/tags) and/or
manage sharing (owners, shared_with, org_access) โ only owners may change sharing.
owners and `shared_w
PATCH /v1/dashboard/insights/{id}
const { data } = await client.patchInsight(
{
id: '123e4567-e89b-12d3-a456-426614174000',
},
{
owners: ['string'],
shared_with: [
{
user_id: '10598',
permission: 'view'
}
],
org_access: 'view',
name: 'string',
description: 'string',
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'
}
},
tags: ['revenue', 'marketing']
},
)
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "view",
"id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
"name": "Opportunities created by journeys every month",
"description": "Monthly count of opportunities grouped by source journey",
"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"
}
},
"tags": ["revenue", "marketing"]
}
deleteInsightโ
Delete an insight by ID. Only owners may delete.
DELETE /v1/dashboard/insights/{id}
const { data } = await client.deleteInsight({
id: '123e4567-e89b-12d3-a456-426614174000',
})
Response
{
"created_by": "10598",
"created_at": "1970-01-01T00:00:00.000Z",
"updated_by": "10598",
"updated_at": "1970-01-01T00:00:00.000Z",
"owner_org_id": "739224",
"owners": ["10598"],
"shared_with": [
{
"user_id": "10598",
"permission": "view"
}
],
"org_access": "view",
"id": "8d2e1c7a-3b4f-4a2e-9c1d-2f3a4b5c6d7e",
"name": "Opportunities created by journeys every month",
"description": "Monthly count of opportunities grouped by source journey",
"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"
}
},
"tags": ["revenue", "marketing"]
}
listAvailableVisualisationsโ
Returns list of available Visualisations to configure new dashboard tiles
GET /v1/dashboard/visualisations
const { data } = await client.listAvailableVisualisations()
Response
{
"results": [
{
"visualisation": "timechart",
"title": "Time Series Visualisation",
"description": "Visualise your metrics with respect to time series",
"package_name": "@epilot360/highcharts"
},
{
"visualisation": "kpi",
"title": "KPI Visualisation",
"description": "Visualise your key performance indicators",
"package_name": "@epilot360/kpi"
}
]
}
listAvailableExamplesโ
Returns list of available exampless for visualisations to configure new dashboard tiles
GET /v1/dashboard/examples
const { data } = await client.listAvailableExamples()
Response
{
"results": [
{
"id": "e4af1297-1fd6-440f-9846-f475f580d40f",
"title": "Number of opportunities created by journeys every month",
"visualisation": "timechart",
"query": {
"dataset": "entity_operations",
"measure": "count_operations",
"dimensions": [
{
"time_with_granularity": "year-month"
}
],
"filters": [
{
"entity_schema": "opportunity"
}
]
}
}
]
}
Schemasโ
DashboardIDโ
Unique identifier for dashboard
type DashboardID = string // uuid
Dashboardโ
A dashboard configuration. A dashboard is a canvas whose tiles arrange and
position insights (saved charts). Tiles may reference an insight by insight_id
or, for backwards compatibility, embed a visualisation inline.
type Dashboard = {
created_by?: string
created_at?: string // date-time
updated_by?: string
updated_at?: string // date-time
owner_org_id?: string
owners?: string[]
shared_with?: Array<{
user_id: string
permission: "view" | "edit"
}>
org_access?: "view" | "edit" | null
id?: string // uuid
title: string
tiles: Array<{
id?: string // uuid
coordinates?: object
title?: string
insight_id?: string // uuid
visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
visualisation_config?: {
query?: { ... }
options?: { ... }
}
}>
favorited?: boolean
}
DashboardTileIDโ
Unique identifier for a tile in a dashboard
type DashboardTileID = string // uuid
SharePermissionโ
Permission level granted to a user (or the whole organization) on a shared resource.
view allows read-only access; edit additionally allows updating the content.
Full control (delete and managing sharing) is reserved for owners.
type SharePermission = "view" | "edit"
ShareGrantโ
Grants a single user a permission level on a resource
type ShareGrant = {
user_id: string
permission: "view" | "edit"
}
OrgAccessโ
Optional organization-wide grant. When set, every user in the resource's organization
is granted this permission level. null (or omitted) means the resource is not shared
org-wide.
type OrgAccess = "view" | "edit" | null
AccessControlโ
Ownership and sharing metadata common to dashboards and insights. created_*/updated_*
fields are managed by the server. owners, shared_with and org_access describe who
may access the resource. New resources are private to their creator until shared.
type AccessControl = {
created_by?: string
created_at?: string // date-time
updated_by?: string
updated_at?: string // date-time
owner_org_id?: string
owners?: string[]
shared_with?: Array<{
user_id: string
permission: "view" | "edit"
}>
org_access?: "view" | "edit" | null
}
AccessControlUpdateโ
Sharing fields that can be mutated via PATCH (owners only). owners and shared_with are
full replacements of their arrays, not merges โ omit a field to leave it unchanged.
type AccessControlUpdate = {
owners?: string[]
shared_with?: Array<{
user_id: string
permission: "view" | "edit"
}>
org_access?: "view" | "edit" | null
}
DashboardPatchโ
Fields that can be partially updated on a dashboard
type DashboardPatch = {
owners?: string[]
shared_with?: Array<{
user_id: string
permission: "view" | "edit"
}>
org_access?: "view" | "edit" | null
title?: string
tiles?: Array<{
id?: string // uuid
coordinates?: object
title?: string
insight_id?: string // uuid
visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
visualisation_config?: {
query?: { ... }
options?: { ... }
}
}>
}
InsightIDโ
Unique identifier for an insight (a saved chart / visualisation)
type InsightID = string // uuid
Insightโ
An insight is a saved, reusable chart definition (a visualisation plus its query/options).
Insights exist independently of dashboards: they can be created, shared and edited on their
own, and referenced by one or more dashboard tiles via insight_id.
type Insight = {
created_by?: string
created_at?: string // date-time
updated_by?: string
updated_at?: string // date-time
owner_org_id?: string
owners?: string[]
shared_with?: Array<{
user_id: string
permission: "view" | "edit"
}>
org_access?: "view" | "edit" | null
id?: string // uuid
name: string
description?: string
visualisation_id: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
visualisation_config?: {
query?: {
dataset?: { ... }
measure?: { ... }
dimensions?: { ... }
filters?: { ... }
}
options?: Record<string, unknown>
}
tags?: string[]
}
InsightPatchโ
Fields that can be partially updated on an insight
type InsightPatch = {
owners?: string[]
shared_with?: Array<{
user_id: string
permission: "view" | "edit"
}>
org_access?: "view" | "edit" | null
name?: string
description?: string
visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
visualisation_config?: {
query?: {
dataset?: { ... }
measure?: { ... }
dimensions?: { ... }
filters?: { ... }
}
options?: Record<string, unknown>
}
tags?: string[]
}
Tagsโ
Free-form labels for grouping and filtering insights
type Tags = string[]
Paginationโ
Offset-based pagination metadata for list responses
type Pagination = {
total: number
limit: number
offset: number
has_more: boolean
}
DashboardTileโ
A positioned tile on a dashboard canvas. A tile references a saved insight via
insight_id. Inline visualisation_id/visualisation_config remain supported for
backwards compatibility (ad-hoc tiles that are not backed by a shared insight).
type DashboardTile = {
id?: string // uuid
coordinates?: object
title?: string
insight_id?: string // uuid
visualisation_id?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
visualisation_config?: {
query?: {
dataset?: { ... }
measure?: { ... }
dimensions?: { ... }
filters?: { ... }
}
options?: Record<string, unknown>
}
}
VisualisationConfigโ
type VisualisationConfig = {
query?: {
dataset?: string
measure?: string
dimensions?: Record<string, unknown>[]
filters?: Record<string, unknown>[]
}
options?: Record<string, unknown>
}
timechartVisualisationConfigโ
type timechartVisualisationConfig = {
query?: {
dataset?: string
measure?: string
dimensions?: Record<string, unknown>[]
filters?: Record<string, unknown>[]
}
options?: Record<string, unknown>
}
ExampleIDโ
Unique identifier for a visualisation examples for tiles in a dashboard
type ExampleID = string // uuid
Exampleโ
type Example = {
id?: string // uuid
title?: string
visualisation?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
query?: {
dataset?: string
measure?: string
dimensions?: Record<string, unknown>[]
filters?: Record<string, unknown>[]
}
}
DatalakeQueryโ
type DatalakeQuery = {
dataset?: string
measure?: string
dimensions?: Record<string, unknown>[]
filters?: Record<string, unknown>[]
}
VisualisationIdโ
Unique identifier for a Visualisation
type VisualisationId = "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
Visualisationโ
A Visualisation that can be used to configure tiles in dashboards
type Visualisation = {
visualisation?: "kpi" | "funnel" | "toplist" | "timechart" | "pie" | "bar" | "entity_list" | "markdown" | "news_feed" | "workflow"
title?: string
description?: string
package_name?: string
import_url?: string // uri
}