From 25f03135c689417acf3d5440d91082e2584c7553 Mon Sep 17 00:00:00 2001 From: brettlangdon Date: Sun, 31 Jul 2016 16:23:28 -0400 Subject: [PATCH] Update documentation --- index.html | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/index.html b/index.html index c863c38..5e61910 100644 --- a/index.html +++ b/index.html @@ -1183,27 +1183,21 @@ dogapi.monitor.unmuteAll(function(err, res){
  • share
  • -

    create(title, description, graphs, options, callback)

    +

    create(boardTitle, widgets, options, callback)

    create a new screenboard

    Parameters:

    -
    title
    +
    boardTitle

    the name of the screenboard

    -
    description
    -

    description of the screenboard

    -
    -
    graphs
    -

    an array of objects which required the following keys

    - +
    widgets
    +

    an array of widgets, see http://docs.datadoghq.com/api/screenboards/ for more info

    options

    optional, a object which can contain any of the following keys

      +
    • description: description of the screenboard
    • templateVariables: | an array of objects with the following keys
      • name: the name of the variable
      • @@ -1213,6 +1207,7 @@ an array of objects with the following keys
        • width: the width of the screenboard in pixels
        • height: the height of the screenboard in pixels
        • +
        • readOnly: the read-only status of the screenboard
    callback
    @@ -1227,9 +1222,8 @@ var options = { app_key: "app_key" }; dogapi.initialize(options); -var title = "my screenboard"; -var description = "it is super awesome"; -var graphs = [ +var boardTitle = "my screenboard"; +var widgets = [ { type: "image", height: 20, @@ -1246,10 +1240,11 @@ var options = { prefix: "host", "default": "host:my-host" } - ] + ], + description: "it is super awesome" }; dogapi.screenboard.create( - title, description, graphs, options, + boardTitle, widgets, options, function(err, res){ console.dir(res); }