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