Graphiques JSON
Rapport de recherche Datadog : Bilan sur l'adoption de l'informatique sans serveur Rapport : Bilan sur l'adoption de l'informatique sans serveur

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ètreTypeDescription
titlechaîneTitre de votre dashboard.
descriptionchaîneDescription du dashboard.
layout_typeenumType de disposition du dashboard. Valeurs autorisées : ordered (disposition du timeboard précédent) ou free (disposition du screenboard précédent).
is_read_onlyBooléenIndique 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_variablestableau d’objetsListe des template variables utilisables dans ce dashboard. Consultez la documentation relative au schéma des template variables pour en savoir plus.
notify_listtableau de stringsListe des handles des utilisateurs à notifier lorsque des changements sont apportés à ce dashboard.
widgetstableau d’objetsListe 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ètreTypeDescription
namechaîneNom de votre template variable.
defaultchaîneValeur par défaut de votre template variable.
prefixchaîneClé 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: