List dashboards | Labric

[
  {
    "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"
  }
]

Lists the organization’s dashboards, filtered by publish status or author if given. Items are omitted. Get a dashboard to see its items.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

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

Query parameters

publish_statusenum or nullOptional

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:

user_idstring or nullOptional

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