Pixela API Document

API Document for Pixela ( https://pixe.la/ ) .

PUT - /v1/users/<username>/graphs/<graphID>/add

Description

Add quantity to the "Pixel" of the day (it is used "timezone" setting if Graph's "timezone" is specified, if not specified, calculates it in "UTC").
You can specify the quantity in the request body.
If the pixel of the day does not exist, the pixel is registered automatically.

Help page

Instant recording - Pixela Help Center

HTTP Method , API endpoint

PUT /v1/users/<username>/graphs/<graphID>/add

Request Header

Key Description
X-USER-TOKEN [required] It is the authentication token specified at the time of user registration.

Request Body

Key Type Description
quantity string [required] Specify the quantity to be added to the pixel of the day.
Validation rule: int ^\-?[0-9]+ , float ^\-?[0-9]+\.[0-9]+

Possible errors by HTTP response status code

  • 400 Bad Request
    • This is an error if there is some mistake in your request. Unless the mistake is corrected, the request will not succeed.
  • 404 Not Found
    • This error occurs when your request destination does not exist.
    • This error also occurs when authentication to the request destination is not successful.
  • 500 Internal Server Error
    • Status in the event of an unexpected error. Retrying the request may be successfully processed.
  • 503 Service Unavailable
    • This error occurs when Pixela is temporarily unavailable. Please take a moment and retry your request.
    • If the response body contains "isRejected":true, it indicates that the request was rejected 25% of the time. In this case, the request can be retried until it succeeds.

Example

$ curl -X PUT https://pixe.la/v1/users/a-know/graphs/test-graph/add -H 'X-USER-TOKEN:thisissecret' -d '{"quantity":"5"}'
{"message":"Success.","isSuccess":true}