Get Default Metrics Overview Board

{
  "id": "board_9876543210abcdef",
  "orgId": "org_1234567890abcdef",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-04-20T15:45:00Z",
  "name": "Default Metrics Overview",
  "layout": {
    "columns": 6
  },
  "items": [
    {
      "insightId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "position": {
        "x": 2,
        "y": 3
      },
      "size": {
        "height": 3,
        "width": 4
      },
      "systemKey": "sys_insight_001",
      "type": "insight"
    }
  ],
  "systemKey": "sys_board_default_metrics",
  "timeRangeOverride": {
    "step": "day",
    "start": "-7d",
    "end": "now",
    "timezone": "UTC"
  }
}

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Response

idstring

This is the unique identifier for the Board.

orgIdstring

This is the unique identifier for the org that this Board belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the Board was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the Board was last updated.

namestring1-40 characters

This is the name of the Board.

layoutobject

This is the layout of the Board.

itemslist of objectsOptional

This is the contents of the Board, which is an array of objects defining the type, contents, and position of the widgets on the Board.

systemKeystringOptional

Server-owned key for system-provisioned boards. User create/update DTOs do not accept this field.

timeRangeOverrideobjectOptional

This is the timerange override for the board. By default, individual insights have their own timerange. This is a global override for the board which will be passed to all insights on the board.

$	curl https://api.vapi.ai/reporting/board/default/metrics-overview \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"