Graphing with JSON

If you query a Datadog timeboard though the dashboard API, the result is a JSON object with the following layout:

DASHBOARD_SCHEMA = {
    "type": "object",
    "properties": {
        "title": {"type": "string"},
        "description": {"type": "string"},
        "layout_type": {"enum": ["ordered", "free"]},
        "is_read_only": {"type": "boolean"},
        "template_variables": {"type": "array", "items": TEMPLATE_VARIABLE_SCHEMA},
        "notify_list": {"type": "array", "items": {"type": "string"}},
        "widgets": {
            "type": "array",
            "items": WIDGET_SCHEMA
        }
    },
    "required": ["title", "layout_type", "widgets"],
}

Parameter	Type	Description
`title`	string	Title of your dashboard.
`description`	string	Description of the dashboard.
`layout_type`	enum	Layout type of the dashboard. Available values are: `ordered` (previous timeboard) or `free` (previous screenboard layout)
`is_read_only`	Boolean	Whether this dashboard is read-only. If `true`, only the dashboard author and administrators can apply changes to it.
`template_variables`	array of object	List of template variables for this dashboard. See the template variable schema documentation to learn more.
`notify_list`	array of strings	List of handles of users to notify when changes are made to this dashboard.
`widgets`	array of object	List of widgets to display on the dashboard. See the dedicated Widget JSON schema documentation to build the `WIDGET_SCHEMA`.

Template variable schema

Dashboard template variables apply a new scope to one or more graphs on your dashboard. This allows you to dynamically explore metrics across different sets of tags by using variables instead of specific tags. To configure them through the Dashboard API, use the following layout:

TEMPLATE_VARIABLE_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "default": {"type": "string"},
        "prefix": {"type": "string"},
    },
    "additionalProperties": false,
    "required": ["name"]
}

Parameter	Type	Description
`name`	string	Name of your template variable.
`default`	string	Default value for your template variable.
`prefix`	string	Tag group for your template variable.

Learn more about template variable in the Datadog UI.

Graphing with JSON

Template variable schema

Further Reading

Table of Contents