Build dashboards on your own data, including multi-customer views with per-customer login.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add one of your customers to a multi-customer dashboard. The customerId must exactly match the value that identifies them in your own database, because it is what gets bound to :customer_id in every widget query. Adding a customer does not give anyone access; use add_customer_user for that. Subject to your plan's customer limit.
Display name for this customer, for your own reference.
The identifier for this customer in your own data, for example the value in your orders.customer_id column. Must match exactly.
A dashboard of type 'customer'.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Add one of your customers to a multi-customer dashboard. The customerId must exactly match the value that identifies them in your own database, because it is what gets bound to :customer_id in every widget query. Adding a customer does not give anyone access; use add_customer_user for that. Subject to your plan's customer limit.
| Argument | Type | Description |
|---|---|---|
| name* | string | Display name for this customer, for your own reference. |
| customerId* | string | The identifier for this customer in your own data, for example the value in your orders.customer_id column. Must match exactly. |
| dashboardId* | string | A dashboard of type 'customer'. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"name",
"customerId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Display name for this customer, for your own reference."
},
"customerId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The identifier for this customer in your own data, for example the value in your orders.customer_id column. Must match exactly."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "A dashboard of type 'customer'."
}
}
}Create a login for one of your customers so they can sign in to the published dashboard and see their own data. If you do not supply a password a strong one is generated and returned once. Subject to your plan's users-per-customer limit.
| Argument | Type | Description |
|---|---|---|
| email* | string | The person's email address. Must be unique on this dashboard. |
| password | string | Leave empty to have a strong password generated. |
| dashboardId* | string | Dashboard id. |
| customerRecordId* | string | The customer's id from list_customers. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"customerRecordId",
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "The person's email address. Must be unique on this dashboard."
},
"password": {
"type": "string",
"maxLength": 200,
"minLength": 4,
"description": "Leave empty to have a strong password generated."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"customerRecordId": {
"type": "string",
"minLength": 1,
"description": "The customer's id from list_customers."
}
}
}Connect a new database or spreadsheet to your workspace. Test the settings with test_data_source_connection first: this tool saves them whether or not they work. Subject to your plan's data source limit.
| Argument | Type | Description |
|---|---|---|
| name* | string | A name for this connection, shown in the dashboard editor. |
| type* | string | Connector type. Call list_supported_data_connectors for the settings each one expects. |
| config* | object | Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"type",
"config"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "A name for this connection, shown in the dashboard editor."
},
"type": {
"enum": [
"postgres",
"mysql",
"mssql",
"oracle",
"aurora",
"redshift",
"bigquery",
"snowflake",
"googleSheets",
"api",
"custom"
],
"type": "string",
"description": "Connector type. Call list_supported_data_connectors for the settings each one expects."
},
"config": {
"type": "object",
"description": "Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
}Create a dashboard. Use type 'customer' for a multi-customer dashboard where each of your customers signs in and sees only their own rows, or 'internal' for a normal dashboard you view yourself or publish as one shared view. A 'Default' view is created automatically. Subject to your plan's dashboard limit.
| Argument | Type | Description |
|---|---|---|
| name* | string | Dashboard name. |
| type | string | 'customer' for a per-customer, login-gated dashboard; 'internal' for a single shared dashboard. Defaults to 'internal'. This cannot be changed later. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Dashboard name."
},
"type": {
"enum": [
"internal",
"customer"
],
"type": "string",
"description": "'customer' for a per-customer, login-gated dashboard; 'internal' for a single shared dashboard. Defaults to 'internal'. This cannot be changed later."
}
}
}Add a view (tab) to a dashboard. New views are appended after the existing ones. Subject to your plan's view limit.
| Argument | Type | Description |
|---|---|---|
| name* | string | View name, shown on the tab. |
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "View name, shown on the tab."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Add a chart, table or KPI to a view. Call list_widget_types for the visualizationConfig each type needs, and run_query_preview first to confirm the query returns the columns you are about to reference. On a multi-customer dashboard the query must filter on :customer_id. Subject to your plan's widget limit.
| Argument | Type | Description |
|---|---|---|
| query* | string | SQL, or an A1 range for Google Sheets. On a customer dashboard include :customer_id, for example "WHERE customer_id = :customer_id". |
| title* | string | Widget title. |
| layout | object | Position and size on the 12-column grid. Omit on create and a free slot is chosen for you. |
| viewId* | string | View id the widget belongs to. |
| dataSourceId* | string | Data source the query runs against. |
| visualizationType* | string | |
| visualizationConfig | object | Field mappings and display options for this visualization type. Call list_widget_types for the keys each type expects. |
| allowSharedAcrossAllCustomers |
Permanently remove a customer from a multi-customer dashboard, along with all of their logins. They lose access immediately. Calling this without confirm returns a preview. This cannot be undone.
| Argument | Type | Description |
|---|---|---|
| confirm | boolean | Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting. |
| confirmName | string | The exact current name of the item being deleted, copied from the preview. Required alongside confirm. |
| dashboardId* | string | Dashboard id. |
| customerRecordId* | string | The customer's id from list_customers. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"customerRecordId"
],
"properties": {
"confirm": {
"type": "boolean",
"description": "Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting."
},
"confirmName": {
"type": "string",
"description": "The exact current name of the item being deleted, copied from the preview. Required alongside confirm."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"customerRecordId": {
"type": "string",
"minLength": 1,
"description": "The customer's id from list_customers."
}
}
}Permanently remove one login from a customer. They can no longer sign in. Calling this without confirm returns a preview. The customer itself and their data access rule remain.
| Argument | Type | Description |
|---|---|---|
| userId* | string | The login's id. |
| confirm | boolean | Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting. |
| confirmName | string | The exact current name of the item being deleted, copied from the preview. Required alongside confirm. |
| dashboardId* | string | Dashboard id. |
| customerRecordId* | string | The customer's id from list_customers. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"customerRecordId",
"userId"
],
"properties": {
"userId": {
"type": "string",
"minLength": 1,
"description": "The login's id."
},
"confirm": {
"type": "boolean",
"description": "Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting."
},
"confirmName": {
"type": "string",
"description": "The exact current name of the item being deleted, copied from the preview. Required alongside confirm."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"customerRecordId": {
"type": "string",
"minLength": 1,
"description": "The customer's id from list_customers."
}
}
}Permanently delete a dashboard and everything on it. Calling this without confirm returns a preview of what would be removed; deleting for real needs confirm plus the dashboard's exact name. This cannot be undone.
| Argument | Type | Description |
|---|---|---|
| confirm | boolean | Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting. |
| confirmName | string | The exact current name of the item being deleted, copied from the preview. Required alongside confirm. |
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"confirm": {
"type": "boolean",
"description": "Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting."
},
"confirmName": {
"type": "string",
"description": "The exact current name of the item being deleted, copied from the preview. Required alongside confirm."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Permanently delete a data source connection. This is refused while any widget still uses it. Calling this without confirm returns a preview. Your actual database is untouched; only the connection is removed.
| Argument | Type | Description |
|---|---|---|
| confirm | boolean | Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting. |
| confirmName | string | The exact current name of the item being deleted, copied from the preview. Required alongside confirm. |
| dataSourceId* | string | Data source id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dataSourceId"
],
"properties": {
"confirm": {
"type": "boolean",
"description": "Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting."
},
"confirmName": {
"type": "string",
"description": "The exact current name of the item being deleted, copied from the preview. Required alongside confirm."
},
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Data source id."
}
}
}Permanently delete a view and every widget on it. Calling this without confirm returns a preview. This cannot be undone.
| Argument | Type | Description |
|---|---|---|
| viewId* | string | View id. |
| confirm | boolean | Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting. |
| confirmName | string | The exact current name of the item being deleted, copied from the preview. Required alongside confirm. |
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"viewId"
],
"properties": {
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id."
},
"confirm": {
"type": "boolean",
"description": "Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting."
},
"confirmName": {
"type": "string",
"description": "The exact current name of the item being deleted, copied from the preview. Required alongside confirm."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Permanently delete a widget. Calling this without confirm returns a preview. This cannot be undone.
| Argument | Type | Description |
|---|---|---|
| viewId* | string | View id. |
| confirm | boolean | Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting. |
| widgetId* | string | Widget id. |
| confirmName | string | The exact current name of the item being deleted, copied from the preview. Required alongside confirm. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"viewId",
"widgetId"
],
"properties": {
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id."
},
"confirm": {
"type": "boolean",
"description": "Set to true only after the user has seen what will be deleted and explicitly agreed. Calling without it returns a preview instead of deleting."
},
"widgetId": {
"type": "string",
"minLength": 1,
"description": "Widget id."
},
"confirmName": {
"type": "string",
"description": "The exact current name of the item being deleted, copied from the preview. Required alongside confirm."
}
}
}Explain exactly how to write widget queries so each customer only sees their own rows on a multi-customer dashboard. Call this before writing any query for a `customer` type dashboard. No sign-in required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get the signed-in CustomerDashboard account: name, email, workspace, current plan, what the plan allows and how much of it is already used. Call this first in an authenticated session to learn the workspace you are working in.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Get one dashboard in full: its settings, theme, publishing state, every view, and every widget on each view including the widget queries. This is the fastest way to understand an existing dashboard before changing it.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
| includeWidgets | boolean | Include every widget on every view. Defaults to true. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"includeWidgets": {
"type": "boolean",
"description": "Include every widget on every view. Defaults to true."
}
}
}Get the public URL of a published dashboard, and who can open it. Returns nothing to share if the dashboard is still private.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Get one data source by id, including its non-secret connection settings. Credentials are never included.
| Argument | Type | Description |
|---|---|---|
| dataSourceId* | string | Data source id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dataSourceId"
],
"properties": {
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Data source id."
}
}
}List the tables and columns available in a connected data source, so you can write correct widget queries. Supported for PostgreSQL, MySQL, SQL Server, Oracle, Aurora, Redshift and Google Sheets.
| Argument | Type | Description |
|---|---|---|
| table | string | Return only this table. Useful when a database has many tables. |
| dataSourceId* | string | Data source id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dataSourceId"
],
"properties": {
"table": {
"type": "string",
"description": "Return only this table. Useful when a database has many tables."
},
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Data source id."
}
}
}Explain what CustomerDashboard.io is, how multi-customer dashboards work, and how workspaces, dashboards, views, widgets and customers fit together. Call this first when you are unfamiliar with the product. No sign-in required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Explain how to sign up for the free trial and connect this MCP server to a CustomerDashboard account, plus the order of steps for building a first multi-customer dashboard. No sign-in required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List the customers on a multi-customer dashboard, each with the customerId their data is filtered by and how many logins they have.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
| includeUsers | boolean | Include each customer's login email addresses. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"includeUsers": {
"type": "boolean",
"description": "Include each customer's login email addresses."
}
}
}List every dashboard in your workspace, with its type, publishing state and share URL if published.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List every data source connected to your workspace. Connection credentials are never included.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List CustomerDashboard's subscription plans, their monthly price and the resource limits each one allows. Useful for explaining why a create operation was blocked. No sign-in required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List every data source type CustomerDashboard can connect to, the settings each one needs, whether widgets can query it, and whether its schema can be introspected. No sign-in required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List the views (tabs) on a dashboard, in display order, with how many widgets each one holds.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}List every visualization a widget can use, with the visualizationConfig keys each type requires and accepts. Call this before creating widgets so the configuration is correct first time. No sign-in required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List the widgets on a view, including each widget's query and visualization configuration.
| Argument | Type | Description |
|---|---|---|
| viewId* | string | View id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"viewId"
],
"properties": {
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id."
}
}
}Publish a dashboard and return its share URL. A customer dashboard is always login-gated, so its customers sign in with the logins you created. An internal dashboard can be published as 'public' (anyone with the link) or 'protected' (one shared username and password).
| Argument | Type | Description |
|---|---|---|
| access | string | For internal dashboards: 'public' means anyone with the link, 'protected' requires a shared username and password. Ignored for customer dashboards, which always require a per-customer login. Defaults to 'protected'. |
| password | string | Shared password, for 'protected' access. Leave empty to have one generated and returned once. |
| username | string | Shared username, for 'protected' access. |
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"access": {
"enum": [
"public",
"protected"
],
"type": "string",
"description": "For internal dashboards: 'public' means anyone with the link, 'protected' requires a shared username and password. Ignored for customer dashboards, which always require a per-customer login. Defaults to 'protected'."
},
"password": {
"type": "string",
"maxLength": 200,
"minLength": 4,
"description": "Shared password, for 'protected' access. Leave empty to have one generated and returned once."
},
"username": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Shared username, for 'protected' access."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Set the tab order of a dashboard's views. Pass every view id in the order you want them shown. This is also the order they rotate in on a wall display.
| Argument | Type | Description |
|---|---|---|
| viewIds* | array | Every view id on this dashboard, in the order you want. |
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"viewIds"
],
"properties": {
"viewIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "Every view id on this dashboard, in the order you want."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Run a query against a connected data source and return the first few rows, so you can confirm it works before putting it on a widget. Results are capped at 100 rows. If the query contains :customer_id you must also say which customer to preview as, using customerId or dashboardId.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Rows to return. Defaults to 25. |
| query* | string | The SQL to run, or an A1 range for Google Sheets. Use :customer_id where a customer's own identifier belongs. |
| customerId | string | The id of a customer (from list_customers) to run the query as. Required when the query uses :customer_id, unless dashboardId is given. |
| dashboardId | string | A customer dashboard whose configured test customer should be used instead of a real customer. Only needed when the query uses :customer_id. |
| dataSourceId* | string | Data source id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dataSourceId",
"query"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return. Defaults to 25."
},
"query": {
"type": "string",
"minLength": 1,
"description": "The SQL to run, or an A1 range for Google Sheets. Use :customer_id where a customer's own identifier belongs."
},
"customerId": {
"type": "string",
"description": "The id of a customer (from list_customers) to run the query as. Required when the query uses :customer_id, unless dashboardId is given."
},
"dashboardId": {
"type": "string",
"description": "A customer dashboard whose configured test customer should be used instead of a real customer. Only needed when the query uses :customer_id."
},
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Data source id."
}
}
}Set the default locale and number, currency, percentage, duration, date and datetime formatting for a dashboard. Individual widgets can still override these.
| Argument | Type | Description |
|---|---|---|
| date | object | |
| locale | string | BCP 47 locale such as en-US, en-GB or de-DE. |
| number | object | |
| currency | object | For example { "currency": "USD", "decimals": 2 }. |
| datetime | object | |
| duration | object | |
| percentage | object | |
| dashboardId* | string | Dashboard id. |
| nullDisplay | string | What to show for an empty value, for example a dash. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"date": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"locale": {
"type": "string",
"maxLength": 20,
"description": "BCP 47 locale such as en-US, en-GB or de-DE."
},
"number": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"currency": {
"type": "object",
"description": "For example { \"currency\": \"USD\", \"decimals\": 2 }.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"datetime": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"duration": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"percentage": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"nullDisplay": {
"type": "string",
"maxLength": 20,
"description": "What to show for an empty value, for example a dash."
}
}
}Set the colour theme of a dashboard: page and surface backgrounds, text colours, brand colours and the chart series palette. All colours are hex values. Pass every field, since the theme is stored as one object.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
| surfaceColor* | string | Background of each widget card. |
| backgroundColor* | string | Page background. |
| primaryTextColor* | string | Main text. |
| chartSeriesColors | array | Explicit chart series palette. Leave empty to derive one from the brand colours. |
| primaryBrandColor* | string | Main accent, used as the first chart series colour. |
| secondaryTextColor* | string | Muted and secondary text. |
| secondaryBrandColor | string | Secondary accent, used for the second chart series. |
Reposition several widgets on a view at once, on the 12-column grid. Use this to lay out a whole view rather than moving widgets one at a time.
| Argument | Type | Description |
|---|---|---|
| viewId* | string | View id. |
| layouts* | array | The widgets to move, with their new positions. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"viewId",
"layouts"
],
"properties": {
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id."
},
"layouts": {
"type": "array",
"items": {
"type": "object",
"required": [
"widgetId",
"layout"
],
"properties": {
"layout": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"maximum": 11,
"minimum": 0
},
"y": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"width": {
"type": "integer",
"maximum": 12,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"description": "Position and size on the 12-column grid. Omit on create and a free slot is chosen for you."
},
"widgetId": {
"type": "string",
"minLength": 1
}
}
},
"minItems": 1,
"description": "The widgets to move, with their new positions."
}
}
}Check whether a set of connection settings actually works, before saving them. Pass an existing dataSourceId to retest a saved connection, or a type and config to test new settings.
| Argument | Type | Description |
|---|---|---|
| type | string | Connector type. Call list_supported_data_connectors for the settings each one expects. |
| config | object | Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools. |
| dataSourceId | string | Test a saved data source. Omit to test new settings. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"type": {
"enum": [
"postgres",
"mysql",
"mssql",
"oracle",
"aurora",
"redshift",
"bigquery",
"snowflake",
"googleSheets",
"api",
"custom"
],
"type": "string",
"description": "Connector type. Call list_supported_data_connectors for the settings each one expects."
},
"config": {
"type": "object",
"description": "Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Test a saved data source. Omit to test new settings."
}
}
}Make a dashboard private again. The existing share link stops working immediately, and any shared username and password are cleared. Widgets and data are untouched.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Rename a customer or correct the customerId their data is filtered by. Changing customerId immediately changes which rows they see, so confirm the new value with the user first.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| customerId | string | New identifier from your own data. This changes which rows this customer can see. |
| dashboardId* | string | Dashboard id. |
| customerRecordId* | string | The customer's id from list_customers (not their customerId). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"customerRecordId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"customerId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New identifier from your own data. This changes which rows this customer can see."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"customerRecordId": {
"type": "string",
"minLength": 1,
"description": "The customer's id from list_customers (not their customerId)."
}
}
}Rename a dashboard, set how long each view is shown when the dashboard auto-rotates on a screen, or set the test customer used to preview a customer dashboard. Use set_dashboard_theme for colours and publish_dashboard for sharing.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| dashboardId* | string | Dashboard id. |
| testCustomerId | any | A customer identifier from your own data, used to preview a customer dashboard before real customers exist. This is bound to :customer_id during previews only. |
| viewRotationSeconds | any | Seconds each view is shown before rotating to the next, for wall displays. 0 or null turns rotation off. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"testCustomerId": {
"anyOf": [
{
"type": "string",
"maxLength": 200,
"minLength": 1
},
{
"type": "null"
}
],
"description": "A customer identifier from your own data, used to preview a customer dashboard before real customers exist. This is bound to :customer_id during previews only."
},
"viewRotationSeconds": {
"anyOf": [
{
"type": "integer",
"maximum": 86400,
"minimum": 0
},
{
"type": "null"
}
],
"description": "Seconds each view is shown before rotating to the next, for wall displays. 0 or null turns rotation off."
}
}
}Rename a data source or replace its connection settings. The config you pass replaces the stored one entirely, so include every setting, not just the changed ones.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| config | object | Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools. |
| dataSourceId* | string | Data source id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dataSourceId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"config": {
"type": "object",
"description": "Connection settings for this connector type, for example { host, port, database, username, password, ssl } for postgres. Credentials are stored encrypted at rest and are never returned by read tools.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Data source id."
}
}
}Rename a view. Use reorder_views to change the tab order.
| Argument | Type | Description |
|---|---|---|
| name* | string | New view name. |
| viewId* | string | View id. |
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"viewId",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New view name."
},
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id."
},
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}Change a widget's title, query, visualization type, configuration, data source or position. Only the fields you pass are changed.
| Argument | Type | Description |
|---|---|---|
| query | string | |
| title | string | |
| layout | object | Position and size on the 12-column grid. Omit on create and a free slot is chosen for you. |
| viewId* | string | View id the widget belongs to. |
| widgetId* | string | Widget id. |
| dataSourceId | string | |
| visualizationType | string | |
| visualizationConfig | object | Replaces the whole configuration object, so include every key you want to keep. |
| allowSharedAcrossAllCustomers | boolean | Only for customer dashboards. Set true, after the user explicitly confirms, to allow a query with no per-customer filter. |
Audit a multi-customer dashboard and report any widget whose query would show the same rows to every customer. Run this before publishing a customer dashboard, and any time its queries change.
| Argument | Type | Description |
|---|---|---|
| dashboardId* | string | Dashboard id. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
}
}
}| boolean |
| Only for customer dashboards. Set true, after the user explicitly confirms, to allow a query with no per-customer filter so every customer sees identical rows. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"viewId",
"dataSourceId",
"title",
"query",
"visualizationType"
],
"properties": {
"query": {
"type": "string",
"minLength": 1,
"description": "SQL, or an A1 range for Google Sheets. On a customer dashboard include :customer_id, for example \"WHERE customer_id = :customer_id\"."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Widget title."
},
"layout": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"maximum": 11,
"minimum": 0
},
"y": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"width": {
"type": "integer",
"maximum": 12,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"description": "Position and size on the 12-column grid. Omit on create and a free slot is chosen for you."
},
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id the widget belongs to."
},
"dataSourceId": {
"type": "string",
"minLength": 1,
"description": "Data source the query runs against."
},
"visualizationType": {
"enum": [
"table",
"number",
"lineChart",
"barChart",
"stackedBarChart",
"stackedLineChart",
"comboChart",
"scatterChart",
"histogram",
"pivotTable",
"pieChart"
],
"type": "string"
},
"visualizationConfig": {
"type": "object",
"description": "Field mappings and display options for this visualization type. Call list_widget_types for the keys each type expects.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"allowSharedAcrossAllCustomers": {
"type": "boolean",
"description": "Only for customer dashboards. Set true, after the user explicitly confirms, to allow a query with no per-customer filter so every customer sees identical rows."
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"dashboardId",
"backgroundColor",
"surfaceColor",
"primaryTextColor",
"secondaryTextColor",
"primaryBrandColor"
],
"properties": {
"dashboardId": {
"type": "string",
"minLength": 1,
"description": "Dashboard id."
},
"surfaceColor": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
"description": "Background of each widget card."
},
"backgroundColor": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
"description": "Page background."
},
"primaryTextColor": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
"description": "Main text."
},
"chartSeriesColors": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"maxItems": 20,
"description": "Explicit chart series palette. Leave empty to derive one from the brand colours."
},
"primaryBrandColor": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
"description": "Main accent, used as the first chart series colour."
},
"secondaryTextColor": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
"description": "Muted and secondary text."
},
"secondaryBrandColor": {
"type": "string",
"pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
"description": "Secondary accent, used for the second chart series."
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"viewId",
"widgetId"
],
"properties": {
"query": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"layout": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"maximum": 11,
"minimum": 0
},
"y": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"width": {
"type": "integer",
"maximum": 12,
"minimum": 1
},
"height": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1
}
},
"description": "Position and size on the 12-column grid. Omit on create and a free slot is chosen for you."
},
"viewId": {
"type": "string",
"minLength": 1,
"description": "View id the widget belongs to."
},
"widgetId": {
"type": "string",
"minLength": 1,
"description": "Widget id."
},
"dataSourceId": {
"type": "string",
"minLength": 1
},
"visualizationType": {
"enum": [
"table",
"number",
"lineChart",
"barChart",
"stackedBarChart",
"stackedLineChart",
"comboChart",
"scatterChart",
"histogram",
"pivotTable",
"pieChart"
],
"type": "string"
},
"visualizationConfig": {
"type": "object",
"description": "Replaces the whole configuration object, so include every key you want to keep.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"allowSharedAcrossAllCustomers": {
"type": "boolean",
"description": "Only for customer dashboards. Set true, after the user explicitly confirms, to allow a query with no per-customer filter."
}
}
}