Dashboards Instance

Dashboards

Jump to API response

Plotly API allows users to store their Plotly dashboards The dashboards appear in the user's profile, and can be shared with others just like Plotly Plots.

Reference

• authorization
• actions
  • create
  • list
  • retrieve
  • update
  • partial update
  • trash
  • permanent delete
  • schema

Authorization

Any user with or without a Plotly account may view public dashboards. For private dashboards, see authentication.

Actions

create

You can create new dashboards here. The only required field is content

Example:

//POST https://api.plotly.com/v2/dashboards ---> 200 OK
{
    "content": "{ "version": 2, "settings": {"title": "Dashboard"}}"
}

list

The list of the dashboards owned by a user can be retrieved by making the GET request to the dashboards endpoint, without supplying any parameters. Users can only access their own dashboards using this endpoint.

Example:

// GET https://api.plotly.com/v2/dashboards/
{
    "results": [
        {
        "fid": "abc:123",
        "world_readable":true..
        },
        {
        "fid": "abc:456",
        "world_readable":true..
        },
    ]
}

retrieve

A single dashboard can be retrieved by a GET Request to the dashboards endpoint, along with the fid of the required presentation, as shown below

Example:

// GET https://api.plotly.com/v2/dashboards/{fid}
    {
        "fid": "abc:123",
        "world_readable":true,
        "content": "{ "version": 2, "settings": {"title": "Dashboard"}}"
    },

update

To completely replace the writable meta information of an existing dashboard, you make a PUT request to the dashboards endpoint and include the fid for the dashboard.

Note, only the writable meta information may be updated. This includes content, filename, parent (or parent_path), and world_readable. Note that parent_path may be specified in place of the parent field. Unlike parent, the parent_path field is not an integer id, but rather the complete path of the parent folder from your root folder (e.g., '/folder_nested_off_root/parent_folder/'). A successful PUT response will have a status code of 200 OK.

Example:

// PUT https://api.plotly.com/v2/dashboards/bob:45 --> 200 OK
{
    "parent": -1,
    "world_readable": true,
    "filename": "my_new_filename",
    "content": "{ "version": 2, "settings": {"title": "Dashboard"}}"
}

partial update

To partially update an existing dashboard, you make a PATCH request to the dashboards endpoint and include the fid for the dashboard.

Note, only the writable meta information may be updated. This includes content, filename, parent (or parent_path), and world_readable.

A successful PATCH response will have a status code of 200 OK.

Example:

// PATCH https://api.plotly.com/v2/dashboards/bob:45 --> 200 OK
{
    "world_readable": true,
    "filename": "my_new_filename"
}

trash

This endpoint allows for the recoverable trashing of the dashboard specified in the endpoint detail.

A successful trash response will have a status code of 200 OK.

Example:

// POST https://api.plotly.com/v2/dashboards/plotlvr:9/trash ---> 200 OK

This request is idempotent. Trashing a dashboard that is already trashed will also succeed and return 200 OK.

permanent_delete

This endpoint allows for the permanent deletion of the dashboard specified in the endpoint detail.

A successful deletion response will have a status code of 204 No Content.

Example:

// DELETE https://api.plotly.com/v2/dashboards/plotlvr:9/permanent_delete ---> 204 No Content

schema

Return the JSON schema that defines the structure of a dashboard.

Example:

// GET https://api.plotly.com/v2/dashboards/schema ---> 200 OK