🟩
Pixel
This represents a specific date and a set of a quantity that is recorded for that date.
Related API
- POST - /v1/users/<username>/graphs/<graphID>
- This is an API for registering a new
Pixel
toGraph
specified with<graphID>
.
- GET - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>
- This is an API for retrieving a
Pixel
that corresponding<yyyyMMdd>
date ofGraph
specified with<graphID>
.
- PUT - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>
- This is an API for updating an existing
Pixel
.
- DELETE - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>
- This is an API for deleteing an existing
Pixel
.
Properties and features
Pixel
has the following properties:date
quantity
optionalData
date
This is a property for representing when is the date of
Pixel
.You need to specify the date in
yyyyMMdd
format.quantity
You can specify a quantity that you want to register to the date that specified by
date
with this property.You can’t register a quantity that is not matched with
type
of Graph
that the Pixel
belongs.If you register a decimal as
quantity
to this property, you can specify up to the second decimal place.optionalData
By using this property, you can specify additional information to the date that is specified with
date
.Additionally, as a limited feature for Pixela Supporters, it is possible to add
optionalData
to Graph
’s SVG as an attribute. For more detail, please see the following pages:Specifications
- This API is mainly for updating an existing
Pixel
, but if the correspondingPixel
doesn’t exist, then register a newPixel
at the same time.
Notes
- Information that can be registered in
optionalData
should be matched with the following two conditions: - Must be JSON string.
- Must be a string of less than 10KB in length.
- There are another following ways to register quantity as new
Pixel
or to update existingPixel
: