Update a visualization | Labric

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

Requires edit access to the visualization.

Requires an API key with the write scope.

Authentication

AuthorizationBearer

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

Path parameters

visualization_idstringRequired

Request

This endpoint expects an object.

namestringOptional1-255 characters

New name.

descriptionstring or nullOptional

New description, or null to clear it.

publish_statusenumOptional

New publish status. Authors may submit their own drafts for review. Any other change requires an organization admin.

Allowed values:

dataset_idstringOptionalformat: "uuid"

ID of the dataset the visualization plots.

specificationmap from strings to anyOptional

New chart specification. It replaces the saved one whole.

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

datasetobject or nullOptional

specificationmap from strings to any 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