🟩
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
の値を更新するための他の方法としては、以下のような方法もあります。