Create a dashboard | Labric

curl -X POST https://platform.labric.co/api/v1/dashboards \
     -H "Authorization: Bearer <api_key>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "items": [
    {
      "category": "string"
    }
  ]
}'

{
  "id": "string",
  "name": "string",
  "publish_status": "draft",
  "date_updated": "2024-01-15T09:30:00Z",
  "description": "string",
  "items": [
    {
      "id": "string",
      "category": "visualization",
      "position_x": 1,
      "position_y": 1,
      "size_x": 1,
      "size_y": 1,
      "description": "string",
      "visualization": {
        "id": "string",
        "name": "string",
        "publish_status": "draft",
        "date_updated": "2024-01-15T09:30:00Z",
        "description": "string",
        "dataset": {
          "id": "string",
          "name": "string",
          "publish_status": "draft",
          "date_updated": "2024-01-15T09:30:00Z",
          "description": "string",
          "query": "string",
          "default_parameters": {},
          "user": {
            "clerk_id": "string",
            "email": "string",
            "first_name": "string",
            "last_name": "string",
            "image_url": "string"
          },
          "access_level": "edit"
        },
        "specification": {},
        "user": {
          "clerk_id": "string",
          "email": "string",
          "first_name": "string",
          "last_name": "string",
          "image_url": "string"
        },
        "access_level": "edit"
      },
      "specification": {}
    }
  ],
  "user": {
    "clerk_id": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "image_url": "string"
  },
  "access_level": "edit"
}

Creates a dashboard and any new visualizations among its items in one transaction. New visualizations are validated as in Create a visualization. If a dashboard with the same items exists, returns it instead, regardless of name and layout.

Requires an API key with the write scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired1-255 characters

Name, unique among the organization's dashboards.

itemslist of objectsRequired

Items, in layout order.

descriptionstring or nullOptional

Summary shown under the dashboard's name.

Response

idstringformat: "uuid"

namestring

publish_statusenum

Whether an authored object is finished enough for others to rely on. In review marks a draft its author considers ready for an admin to publish.

Allowed values:

date_updateddatetime

descriptionstring or nullOptional

itemslist of objects or nullOptional

userobject or nullOptional

access_levelenum or nullOptional

What a grant lets its grantee do. Manage includes edit and adds sharing, archiving and deleting.

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error