Get the home dashboard

This workspace’s dashboard: its stats, its layout, and the metrics it can build from

GET /dashboard

Get the home dashboard

cURL

curl --request GET \
  --url https://api.pineyard.ai/dashboard \
  --header 'Authorization: Bearer <token>'

200

{
  "stats": [
    {
      "id": "<string>",
      "title": "<string>",
      "definition": {
        "metricId": "<string>",
        "mode": "value",
        "display": "tile",
        "compareMetricId": "<string>"
      },
      "position": 123,
      "hidden": true
    }
  ],
  "layout": {
    "version": 1,
    "ribbon": {
      "order": [
        "<string>"
      ],
      "hidden": [
        "<string>"
      ],
      "sizes": {}
    },
    "sections": {
      "order": [
        "<string>"
      ],
      "hidden": [
        "<string>"
      ],
      "sizes": {}
    }
  },
  "metrics": [
    {
      "id": "<string>",
      "source": "calls",
      "label": "<string>",
      "description": "<string>",
      "unit": "count",
      "endpoint": "<string>",
      "path": "<string>",
      "supports": [
        "value"
      ]
    }
  ]
}

Required scope: analytics.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

200

application/json

OK

stats · object[] · required

Show child attributes

layout · object · required

Show child attributes

metrics · object[] · required

Show child attributes