Pixela API Document

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

GET - /v1/users/<username>/graphs

Description

Get all predefined pixelation graph definitions.

Help page

Graph - Pixela Help Center

HTTP Method , API endpoint

GET /v1/users/<username>/graphs

Request Header

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

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 GET https://pixe.la/v1/users/a-know/graphs -H 'X-USER-TOKEN:thisissecret'
{"graphs":[{"id":"test-graph","name":"graph-name","unit":"commit","type":"int","color":"shibafu","timezone":"Asia/Tokyo","purgeCacheURLs":["https://camo.githubusercontent.com/xxx/xxxx"],"selfSufficient":"increment","isSecret":false,"publishOptionalData":true}]}