🟩
Pixel
ある特定の日付と、その日に対して投稿された値の組を指します。すべての
Pixel はいずれかの Graph に属します。関連API
- POST - /v1/users/<username>/graphs/<graphID>
<graphID>で指定されたGraphに、新たにPixelを登録するためのAPIです。
- GET - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>
<graphID>で指定されたGraphの<yyyyMMdd>の日付に対応するPixelを取得するためのAPIです。
- PUT - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>
- 登録済みの
Pixelを更新するためのAPIです。
- DELETE - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>
- 登録済みの
Pixelを削除するためのAPIです。
特徴
Pixel には、以下のようなプロパティがあります。date
quantity
optionalData
date
その
Pixel がどの日付のデータであるのかを示すためのプロパティです。 yyyyMMdd 形式で指定します。quantity
date で指定した日付に対して登録したい値をこのプロパティで指定します。この
Pixel が属している Graph の type （ int もしくは float ）に適合していない値を登録することはできません。小数を登録する場合、小数点第二位まで指定することができます。optionalData
date で指定した日付に対して登録したい補足情報を指定することができます。Pixela サポーター限定の機能として、
optionalData を Graph の SVG に属性として付与することができます。詳細は以下のページを参照してください。仕様
- PUT - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> は主に登録済みの
Pixelを更新するための API ですが、対応するPixelが存在しない場合にはPixelの新規登録も行います。
留意事項
optionalDataに登録できる情報は以下の2点を満たすものに限られます。- JSON文字列であること。
- 10KB未満の長さの文字列であること。
Pixelとして値を新規登録したり、もしくは登録済みのPixelの値を更新するための他の方法としては、以下のような方法もあります。