linkbreakers-com · Schema

ListDashboardsResponse

QR CodesLead CaptureWebhookSDK

Properties

Name Type Description
dashboards array
nextPageToken string Cursor to continue listing dashboards. Empty on the last page.
totalCount integer How many records exist in total, so a client can tell a complete answer from a page of one. A local-first client reads absence from this list as deletion, and may only do so when the count it was give
View JSON Schema on GitHub

JSON Schema

linkbreakers-com-list-dashboards-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/linkbreakers-com/json-schema/linkbreakers-com-list-dashboards-response-schema.json",
  "title": "ListDashboardsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/linkbreakers-com-analytics-dashboard-api-openapi.yml#/components/schemas/ListDashboardsResponse",
  "properties": {
    "dashboards": {
      "items": {
        "$ref": "#/$defs/AnalyticsDashboard",
        "type": "object"
      },
      "type": "array"
    },
    "nextPageToken": {
      "description": "Cursor to continue listing dashboards. Empty on the last page.",
      "type": "string"
    },
    "totalCount": {
      "description": "How many records exist in total, so a client can tell a complete answer\nfrom a page of one. A local-first client reads absence from this list as\ndeletion, and may only do so when the count it was given matches what it\nreceived: without that, one page would look like the whole model and\neverything beyond it would be removed locally.",
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object",
  "$defs": {
    "AnalyticsDashboard": {
      "properties": {
        "chatMessages": {
          "items": {
            "$ref": "#/$defs/ChatDisplayMessage",
            "type": "object"
          },
          "title": "User-visible chat messages for rendering in the chat panel",
          "type": "array"
        },
        "config": {
          "$ref": "#/$defs/DashboardConfig"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "linkId": {
          "description": "Link this dashboard is scoped to. Empty for the workspace-wide dashboard.",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "title": "AnalyticsDashboard represents a workspace's analytics dashboard",
      "type": "object"
    },
    "ChatDisplayMessage": {
      "properties": {
        "id": {
          "type": "string"
        },
        "sender": {
          "title": "\"user\" or \"assistant\"",
          "type": "string"
        },
        "text": {
          "type": "string"
        },
        "timestamp": {
          "format": "date-time",
          "type": "string"
        }
      },
      "title": "ChatDisplayMessage is a user-visible chat message for rendering in the UI",
      "type": "object"
    },
    "DashboardConfig": {
      "properties": {
        "gridColumns": {
          "description": "Width of the grid the widget positions and sizes are expressed in.\nAbsent or 0 means the legacy two-column grid, where w=1 is half-width and\nw=2 is full-width. New dashboards use 8.",
          "format": "int32",
          "type": "integer"
        },
        "widgets": {
          "items": {
            "$ref": "#/$defs/DashboardWidget",
            "type": "object"
          },
          "type": "array"
        }
      },
      "title": "DashboardConfig is the structured configuration for a dashboard",
      "type": "object"
    },
    "DashboardWidget": {
      "properties": {
        "dataSource": {
          "$ref": "#/$defs/WidgetDataSource",
          "title": "What data to fetch"
        },
        "id": {
          "title": "Unique widget identifier",
          "type": "string"
        },
        "position": {
          "$ref": "#/$defs/WidgetPosition",
          "title": "Grid position"
        },
        "size": {
          "$ref": "#/$defs/WidgetSize",
          "title": "Grid size"
        },
        "title": {
          "title": "Display title",
          "type": "string"
        },
        "visualization": {
          "$ref": "#/$defs/WidgetVisualization",
          "title": "How to visualize the data"
        }
      },
      "title": "DashboardWidget represents a single monitor widget on the dashboard",
      "type": "object"
    },
    "WidgetDataSource": {
      "properties": {
        "endpoint": {
          "title": "The API endpoint path, e.g. \"/v1/timeseries/events\"",
          "type": "string"
        },
        "method": {
          "title": "HTTP method: \"GET\" or \"POST\"",
          "type": "string"
        },
        "params": {
          "title": "Static parameters always sent with the request",
          "type": "object"
        },
        "responseDataPath": {
          "title": "Dot-notation path to the data array in the response, e.g. \"timeSeries.data\" or \"data\"\nEmpty string means the root object is the data (for single-value endpoints like metrics)",
          "type": "string"
        },
        "usesDateRange": {
          "title": "Whether the dashboard date range should be injected (startDate/endDate)",
          "type": "boolean"
        },
        "usesInterval": {
          "title": "Whether interval calculation should be injected (for time-bucketed data)",
          "type": "boolean"
        }
      },
      "title": "WidgetDataSource describes which API endpoint to call and how to pass parameters",
      "type": "object"
    },
    "WidgetFieldMapping": {
      "properties": {
        "chartRole": {
          "title": "Role in the chart: \"label\", \"value\", \"value2\", \"timestamp\", \"category\"",
          "type": "string"
        },
        "displayLabel": {
          "title": "Display label shown in legend and tooltips",
          "type": "string"
        },
        "sourceField": {
          "title": "Field name in the API response objects, e.g. \"eventCount\", \"timestamp\"",
          "type": "string"
        }
      },
      "title": "WidgetFieldMapping maps a field from the API response to a chart role",
      "type": "object"
    },
    "WidgetPosition": {
      "properties": {
        "x": {
          "format": "int32",
          "title": "Leftmost column the widget occupies, 0-based",
          "type": "integer"
        },
        "y": {
          "format": "int32",
          "title": "Topmost row the widget occupies, 0-based",
          "type": "integer"
        }
      },
      "title": "WidgetPosition defines where a widget sits in the grid",
      "type": "object"
    },
    "WidgetSize": {
      "properties": {
        "h": {
          "format": "int32",
          "title": "Row span, one row being roughly 80px tall",
          "type": "integer"
        },
        "w": {
          "description": "Column span. In an 8-column config: 8 = full width, 4 = half, 2 = quarter.",
          "format": "int32",
          "type": "integer"
        }
      },
      "title": "WidgetSize defines how many grid cells a widget spans",
      "type": "object"
    },
    "WidgetTab": {
      "properties": {
        "label": {
          "title": "Tab display label",
          "type": "string"
        },
        "mode": {
          "$ref": "#/$defs/WidgetTabMode",
          "description": "How this tab produces its content. Absent means data."
        },
        "params": {
          "title": "Params that override the base data source params when this tab is active",
          "type": "object"
        },
        "view": {
          "$ref": "#/$defs/WidgetTabView",
          "description": "How it is drawn. The map used to be chosen by a tab literally labelled\n\"Map\", so renaming it to \"Carte\" lost the map and a data tab called\n\"Site Map clicks\" was hijacked into one."
        }
      },
      "title": "WidgetTab represents a tab for grouped views in a widget",
      "type": "object"
    },
    "WidgetTabMode": {
      "default": "WIDGET_TAB_MODE_UNSPECIFIED",
      "description": "WidgetTabMode says how a tab produces what it shows.\n\n - WIDGET_TAB_MODE_UNSPECIFIED: Fetches the widget's data source with this tab's params, on switch.\n - WIDGET_TAB_MODE_ASSISTANT_SUMMARY: Shows an assistant's analysis of the widget's values. Runs only when the user\nasks, because it costs platform credits, and its result is stored rather\nthan regenerated on every view.",
      "enum": [
        "WIDGET_TAB_MODE_UNSPECIFIED",
        "WIDGET_TAB_MODE_DATA",
        "WIDGET_TAB_MODE_ASSISTANT_SUMMARY"
      ],
      "type": "string"
    },
    "WidgetTabView": {
      "default": "WIDGET_TAB_VIEW_UNSPECIFIED",
      "description": "WidgetTabView says how a tab draws what it fetched.\n\n - WIDGET_TAB_VIEW_UNSPECIFIED: The widget's own chart type.\n - WIDGET_TAB_VIEW_MAP: A world map, which needs rows carrying a country code.",
      "enum": [
        "WIDGET_TAB_VIEW_UNSPECIFIED",
        "WIDGET_TAB_VIEW_CHART",
        "WIDGET_TAB_VIEW_MAP"
      ],
      "type": "string"
    },
    "WidgetVisualization": {
      "properties": {
        "chartType": {
          "title": "Chart type: \"bar\", \"horizontal_bar\", \"line\", \"area\", \"stacked_area\", \"pie\", \"number\", \"list\", \"funnel\"",
          "type": "string"
        },
        "colors": {
          "items": {
            "type": "string"
          },
          "title": "Ordered list of colors for chart series/segments",
          "type": "array"
        },
        "fieldMappings": {
          "items": {
            "$ref": "#/$defs/WidgetFieldMapping",
            "type": "object"
          },
          "title": "Maps response fields to chart roles",
          "type": "array"
        },
        "tabs": {
          "description": "Optional tabs for grouped views. Each tab has label and params that override the base params.",
          "items": {
            "$ref": "#/$defs/WidgetTab",
            "type": "object"
          },
          "type": "array"
        }
      },
      "title": "WidgetVisualization describes how to render the fetched data",
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/linkbreakers-com-list-dashboards-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.