view release on metacpan or  search on metacpan

views/docs.tx  view on Meta::CPAN

: cascade base
: around page_header -> {
<div class="row">
  <div class="col-md-12">
    <h1>Document and Usage</h1>
  </div>
</div>
: }

: around content -> {

<p class="alert alert-info">more details and japanese document are <a href="http://kazeburo.github.com/GrowthForecast/">here</a>.</p>

<hr />

<h3>How to Register Graphs</h3>

<p>To create graphs or update data, make a request to the following URL via a POST method.</p>

<pre>
<: $c.req.uri_for('/') :>api/:service_name/:section_name/:graph_name
</pre>

<div class="row">
<div class="col-md-3">
<p>The names of the items within the URL to POST to are shown in the table to the right.</p>

<p>You can use multi-byte strings for each item name as long as it is UTF-8.</p>
</div>
<div class="col-md-7">

<table class="table">
<tr>
<th>The Name Used in the Example</th>
<th>Purpose</th>
<th>Actual Parameters</th>
</tr>
<tr>
<td>:service_name</td>
<td>The name of the service that you'd like to graph</td>
<td>blog, photo, place, socialgame</td>
</tr>
<tr>
<td>:section_name</td>
<td>The name of the feature or system to graph, within said service.</td>
<td>entry, user, spot, items</td>
</tr>
<tr>
<td>:graph_name</td>
<td>The actual name of the value being graphed</td>
<td>total_entry, kakin_user, muryo_user</td>
</tr>
</table>

</div>
</div>

<p>For example, if we are graphing the number of registered users in a social game, we would POST to the following URL:</p>

<pre>
<: $c.req.uri_for('/') :>api/socialgame/member/register