From b13495ffa6034d1cb0c9dda75305330850a0bed3 Mon Sep 17 00:00:00 2001 From: Brett Langdon Date: Thu, 28 Mar 2013 22:30:58 -0400 Subject: [PATCH] add api documentation to readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84c1b23..2a87501 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,24 @@ npm install * method used to update the dashboard with the provided `dash_id` * `dogapi.delete_dashboard(dash_id, [callback])` * method to remove a dashboard from datadog - +* `dogapi.search(query, [callback])` + * method used to query the api for `metrics` or `hosts` +* `dogapi.add_metric(metric, [callback])` + * method used to add a single metric to datadog +* `dogapi.add_metrics(metrics, [callback])` + * method used to add multiple metrics to datadog +* `dogapi.all_tags([[source], callback])` + * method to get all the tags in datadog +* `dogapi.host_tags(host, [[source], callback])` + * method to get the tags associated with a given `host` +* `dogapi.host_tags_by_source(host, [[source], callback])` + * method to return the tags associated with a host, arranged by source +* `dogapi.add_tags(host, tags, [[source], callback])` + * add new tags to given `host` +* `dogapi.update_tags(host, tags, [[source], callback])` + * update the tags associated with the given `host` +* `dogapi.detach_tags(host, [[source], callback])` + * method to remove tags for a given `host` ## Sample Usage: