グラフの登録方法

以下の URL を POST メソッドで叩いてください。

http://forecast.nekoruri.jp/api/:service_name/:section_name/:graph_name

GrowthForecast では、多数のサービスで利用可能な共通 Web Graph API を目標として作られています。 URL 中の各名前に関しては下の表を参考にしてください。

例中の名前 役割 具体例を , 区切りで
:service_name グラフを取りたいサービスの名前 hatenablog, ficia, loctouch, ninjyatoriai
:section_name そのサービスの中での、グラフを取る対象が属してる機能やシステム名 entry, user, spot, items
:graph_name 具体的に何のグラフか total_entry, kakin_user, muryo_user, syuriken_no_ureta_kazu

もし、忍者取り合いっていうサービスのアイテムの中の手裏剣が売りたい数だったら

http://forecast.nekoruri.jp/api/ninjyatoriai/items/syuriken_no_ureta_kazu

に対して POST します。

また、 POST する時には以下のパラメータをつけます。

パラメータ 説明 必須/オプション
number グラフに与える数値 必須
mode 数値のアップデート方法。count or modified or gauge。
count: 登録済みの数値を number の値で加算
modified: 前回と異なる数値の時だけ上書き更新
gauge: number の数値で常に上書き
デフォルトは gauge
オプション

LWP::UserAgent を使うと以下の用になります。

my $ua = LWP::UserAgent->new;
$ua->post('http://forecast.nekoruri.jp/api/ninjyatoriai/items/syuriken_no_ureta_kazu', {
    number      => 10,
});

curl を使うと以下の用になります。

$ curl -F number=10 http://forecast.nekoruri.jp/api/ninjyatoriai/items/syuriken_no_ureta_kazu

グラフのデータの取り込みは5分また1分毎に1度行われます。POST後すぐに反映されないので注意してください

グラフの表示オプション

グラフのURIに対していくつかオプションを与えるとグラフの描画をカスタマイズすることができます

グラフのURI http://forecast.nekoruri.jp/graph/:service_name/:section_name/:graph_name
複合グラフのURI  http://forecast.nekoruri.jp/graph/:pattern
パラメータ 説明
t グラフの範囲。y(年間)、m(月間)、w(週間)、3d(3日間)、s3d(3日間・1分更新)、d(一日)、sd(一日・1分更新)、8h(8時間)、s8h(8時間・1分更新)、4h(4時間)、s4h(4時間・1分更新)、h(1時間)、sh(1時間・1分更新)、n(半日)、sn(半日・1分更新)、c(任意)、sc(任意・1分更新)
from 「t」が「c」または「sc」の場合、描画する開始日付。「2011/12/08 12:10:00」の形式で指定
to 「t」が「c」または「sc」の場合、描画する終了日付。「2011/12/08 12:10:00」の形式で指定
gmode 積算か差分グラフの選択、「gauge」または「subtract」。デフォルトは「gauge」
width 横幅。実際には凡例などを含むので指定したサイズより大きくなる
height 縦幅。実際には凡例などを含むので指定したサイズより大きくなる
graphonly グラフ部分しか描画しないモード。デフォルト「0」
logarithmic 対数グラフ。デフォルト「0」
xgrid X軸の設定。フォーマットはrrdtoolのドキュメント参照のこと
ygrid Y軸の設定。フォーマットはrrdtoolのドキュメント参照のこと
background_color 背景色。FFFFFF または FFFFFF00 で指定。最後の2文字はアルファチャンネル
canvas_color グラフ部分背景色。FFFFFF または FFFFFF00 で指定
font_color 文字色。FFFFFF または FFFFFF00 で指定
frame_color 凡例の色を囲っている部分。FFFFFF または FFFFFF00 で指定
axis_color グラフ部分の枠線。FFFFFF または FFFFFF00 で指定
shadea_color 左上、上の枠線。FFFFFF または FFFFFF00 で指定
shadeb_color 右下、下の枠線。FFFFFF または FFFFFF00 で指定
border 枠線の太さ。「0」も可能。デフォルト「3」
legend 凡例の有無。デフォルト「1」
sumup 凡例に合計値を含むかどうか。デフォルト「0」

グラフデータのサマリー

グラフデータの凡例部分ををJSON形式でエクスポートできます

グラフのURI http://forecast.nekoruri.jp/summary/:service_name/:section_name/:graph_name
複合グラフのURI  http://forecast.nekoruri.jp/summary/:pattern

パラメータはグラフを描画する時と同じです

グラフデータのエクスポート

グラフデータをJSON形式でエクスポートできます

グラフのURI http://forecast.nekoruri.jp/xport/:service_name/:section_name/:graph_name
複合グラフのURI  http://forecast.nekoruri.jp/xport/:pattern
パラメータ 説明
t グラフの範囲。y(年間)、m(月間)、w(週間)、3d(3日間)、s3d(3日間・1分更新)、d(一日)、sd(一日・1分更新)、8h(8時間)、s8h(8時間・1分更新)、4h(4時間)、s4h(4時間・1分更新)、h(1時間)、sh(1時間・1分更新)、n(半日)、sn(半日・1分更新)、c(任意)、sc(任意・1分更新)
from 「t」が「c」または「sc」の場合、描画する開始日付。「2011/12/08 12:10:00」の形式で指定
to 「t」が「c」または「sc」の場合、描画する終了日付。「2011/12/08 12:10:00」の形式で指定
gmode 積算か差分グラフの選択、「gauge」または「subtract」。デフォルトは「gauge」
width rowの最大個数