Graphiques JSON

Graphiques JSON

Si vous interrogez un timeboard Datadog via l'API dashboard, cela génère un objet JSON avec la disposition suivante :

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"],
}
Paramètre Type Description
title chaîne Titre de votre dashboard.
description chaîne Description du dashboard.
layout_type enum Type de disposition du dashboard. Valeurs autorisées : ordered ou free.
is_read_only Booléen Indique si ce dashboard est en lecture seule. Si ce paramètre a pour valeur True, seuls l’auteur et les administrateurs peuvent effectuer des modifications.
template_variables tableau d’objets Liste des template variables utilisables dans ce dashboard. Consultez la documentation relative au schéma des template variables pour en savoir plus.
notify_list tableau de strings Liste des handles des utilisateurs à notifier lorsque des changements sont apportés à ce dashboard.
widgets tableau d’objets Liste des widgets à afficher dans le dashboard. Consultez la documentation relative au schéma JSON des widgets pour générer le WIDGET_SCHEMA.

Schéma des template variables

Les template variables de dashboard servent à appliquer un nouveau contexte à un ou plusieurs graphiques dans votre dashboard, vous permettant ainsi d’explorer de façon dynamique les métriques associées à différents ensembles de tags en utilisant des variables au lieu de tags spécifiques. Pour les configurer dans l’API Dashboard, utilisez la disposition suivante :

TEMPLATE_VARIABLE_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "default": {"type": "string"},
        "prefix": {"type": "string"},
    },
    "additionalProperties": false,
    "required": ["name"]
}
Paramètre Type Description
name chaîne Nom de votre template variable.
default chaîne Valeur par défaut de votre template variable.
prefix chaîne Clé de tag de votre template variable.

En savoir plus sur les template variables dans l’interface utilisateur de Datadog.

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles: