Browse Source

recompile docs

pull/25/head
Brett Langdon 10 years ago
parent
commit
717feb2ffe
1 changed files with 37 additions and 0 deletions
  1. +37
    -0
      index.html

+ 37
- 0
index.html View File

@ -34,6 +34,8 @@ document.addEventListener("DOMContentLoaded", function(){hljs.initHighlightingOn
</li>
<li role=""><a href="#screenboard">screenboard</a>
</li>
<li role=""><a href="#search">search</a>
</li>
<li role=""><a href="#serviceCheck">serviceCheck</a>
</li>
<li role=""><a href="#tag">tag</a>
@ -1217,6 +1219,41 @@ dogapi.screenboard.share(1234, function(err, res){
</div>
</div>
</section>
<section id="search" class="col-sm-12">
<div class="row">
<h2 class="bg-primary" style="text-indent:1rem">search</h2></div>
<ul class="nav nav-pills">
<li role"presentation"><a href="#search-search">search</a></li>
</ul>
<div class="function row" id="search-search">
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">search(query, callback)</h3>
<div class="col-md-6">
<p>search for metrics and hosts from the past 24 hours</p>
<h4>Parameters:</h4>
<dl>
<dt>query</dt>
<dd><p>the seach query to perform (e.g. &quot;app1&quot; or &quot;hosts:app1&quot; or &quot;metrics:response&quot;)</p>
</dd>
<dt>callback</dt>
<dd><p>function(err, res)</p>
</dd>
</dl>
</div>
<div class="col-md-6">
<pre><code class="lang-javascript">var dogapi = require(&quot;dogapi&quot;);
var options = {
api_key: &quot;api_key&quot;,
app_key: &quot;app_key&quot;
};
dogapi.initialize(options);
var query = &quot;app&quot;;
dogapi.search.search(query, function(err, res){
console.dir(res);
});
</code></pre>
</div>
</div>
</section>
<section id="serviceCheck" class="col-sm-12">
<div class="row">
<h2 class="bg-primary" style="text-indent:1rem">serviceCheck</h2></div>


Loading…
Cancel
Save