layouts

Specific pre-configured layout containing cells and queries.

layouts will hold information about how to layout the page of graphs.

get/layouts/{id}

Request

  • Base URL
    /chronograf/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

idstring required

ID of the layout

Response

Returns the specified layout containing cells.

idstring

ID is an opaque string that uniquely identifies this layout.

appstring required

App is the user facing name of this Layout

measurementstring required

Measurement is the descriptive name of the time series data.

Example response

{
  "id": "0e980b97-c162-487b-a815-3f955df62430",
  "app": "docker",
  "measurement": "docker_container_net",
  "autoflow": true,
  "cells": [
    {
      "x": 0,
      "y": 0,
      "w": 4,
      "h": 4,
      "i": "4c79cefb-5152-410c-9b88-74f9bff7ef23",
      "name": "Docker - Container Network",
      "queries": [
        {
          "query": "SELECT derivative(mean(\"tx_bytes\"), 10s) AS \"net_tx_bytes\" FROM \"docker_container_net\"",
          "groupbys": [
            "\"container_name\""
          ]
        },
        {
          "query": "SELECT derivative(mean(\"rx_bytes\"), 10s) AS \"net_rx_bytes\" FROM \"docker_container_net\"",
          "groupbys": [
            "\"container_name\""
          ]
        }
      ],
      "type": ""
    }
  ],
  "link": {
    "href": "/chronograf/v1/layouts/0e980b97-c162-487b-a815-3f955df62430",
    "rel": "self"
  }
}

Changes

No recorded changes to this operation across all 71 revisions of this API.