🪄
Instant recording
実用に則した記録をサポートするためのAPI群です。
関連API
- PUT - /v1/users/<username>/graphs/<graphID>/increment
- で指定されたグラフのその日の Pixel の値を最小単位分だけ加算します。
- PUT - /v1/users/<username>/graphs/<graphID>/decrement
- で指定されたグラフのその日の Pixel の値を最小単位分だけ減算します。
- PUT - /v1/users/<username>/graphs/<graphID>/add
- で指定されたグラフのその日の Pixel の値に、指定した値を加算します。
- PUT - /v1/users/<username>/graphs/<graphID>/subtract
- で指定されたグラフのその日の Pixel の値から、指定した値を減算します。
- POST - /v1/users/<username>/graphs/<graphID>/stopwatch
- このAPIの詳細については Pixela をストップウォッチとして使い、計測した時間をそのまま記録する を参照してください。
特徴
これらのAPIの共通する特徴として、加算や減算を行う対象の日付を指定する必要がない、という点があります。
それぞれのAPIに対して適切にリクエストすることで、そのAPIを実行した日の値が加算や減算されます。
そのため、値の記録をリアルタイムに行いたい場合に有効です。
仕様
- PUT - /v1/users/<username>/graphs/<graphID>/increment や PUT - /v1/users/<username>/graphs/<graphID>/decrement での加減算で用いられる「最小単位」とは、以下の通りです。
- の が の場合：
- の が の場合：
- 加減算を行う日付の算出の際には、その Graph の が使用されます。
- その日に対応する が存在しなかった場合、 が自動的に新規登録されます。
留意事項
- 値の記録をリアルタイムで行いたいが、なんらかの理由によりHTTPヘッダーを指定することができない（ を指定することができない ）場合には、Webhook のご利用をご検討ください。