Skip to main content
Version: Next

ChartRestApi.put

cache_timeoutintegernullable

Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.

certification_detailsstringnullable

Details of the certification

certified_bystringnullable

Person or group that has certified this chart

dashboardsinteger[]
datasource_idintegernullable

The id of the dataset/datasource this new chart will use. A complete datasource identification needs datasource_id and datasource_type.

datasource_typestringnullable

The type of dataset/datasource identified on datasource_id.

Possible values: [table, dataset, query, saved_query, view, semantic_view, null]

descriptionstringnullable

A description of the chart propose.

editors object[]
  • Array [
    • oneOf

    Subject ID, not a user ID.

    integer

    Subject ID, not a user ID.

  • ]
    • external_urlstringnullable
    is_managed_externallybooleannullable
    paramsstringnullable

    Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.

    query_contextstringnullable

    The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.

    query_context_generationbooleannullable

    The query context generation represents whether the query_contextis user generated or not so that it does not update user modifiedstate.

    slice_namestringnullable

    The name of the chart.

    Possible values: <= 250 characters

    tagsinteger[]
    uuidstring<uuid>nullable
    viewers object[]
  • Array [
    • oneOf

    Subject ID, not a user ID.

    integer

    Subject ID, not a user ID.

  • ]
    • viz_typestringnullable

    The type of chart visualization used.

    Possible values: <= 250 characters

    Example: ["bar","area","table"]
    ChartRestApi.put
    {
      "cache_timeout": 0,
      "certification_details": "string",
      "certified_by": "string",
      "dashboards": [
        0
      ],
      "datasource_id": 0,
      "datasource_type": "table",
      "description": "string",
      "editors": [
        0,
        {
          "id": 0,
          "type": "user"
        }
      ],
      "external_url": "string",
      "is_managed_externally": true,
      "params": "string",
      "query_context": "string",
      "query_context_generation": true,
      "slice_name": "string",
      "tags": [
        0
      ],
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "viewers": [
        0,
        {
          "id": 0,
          "type": "user"
        }
      ],
      "viz_type": [
        "bar",
        "area",
        "table"
      ]
    }