Pixela API Document

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

GET - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>/retina

Description

Displays the Pixel specified by <yyyyMMdd> in a higher resolution (hourly).

HTTP Method , API endpoint

GET /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>/retina

Query Parameter

Key Type Description
appearance string [optional] If you want a dark image that matches the dark theme, specify dark.

Specification

  • If you update Pixela in the way described below, it will be recorded in a format that can also be seen as Retina.
    • If you use the API POST /v1/users/<username>/graphs/<graphID> - Post a pixel to register a Pixel with a date that is not in the past.
      • If you overwrite a registered Pixel, the Retina will be overwritten as well.
      • If you register a Pixel for a past date, the Retina will be removed.
    • If you use the API PUT /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> - Update a pixel to update the Pixel with a date that is not in the past.
      • If you update a registered Pixel, the Retina will be overwritten.
      • If you update the Pixel for a past date, the Retina will be removed.
    • If you use the following API to update the Pixel for the day.
      • PUT /v1/users/<username>/graphs/<graphID>/increment - Increment a pixel
      • PUT /v1/users/<username>/graphs/<graphID>/decrement - Decrement a pixel
      • POST /v1/users/<username>/webhooks/<webhookHash> - Invoke a webhook
      • POST /v1/users/<username>/graphs/<graphID>/stopwatch - Measuring and recording time
      • Pixel increment by Graph with self-sufficient set.
  • Retina recording is done automatically, but you need to be a Pixela Supporter to view data other than that of the day. For details, please check How to support Pixela by Patreon ／ Use Limited Features.

Possible errors by HTTP response status code

  • 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.

Example

$ curl -X GET https://pixe.la/v1/users/a-know/graphs/test-graph/20210501/retina?appearance=dark
<svg xmlns="http://www.w3.org/2000/svg" width="220" height="135" ...