Pixela API Document

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

Entries from 2019-04-24 to 1 day

DELETE - /v1/users/<username>/webhooks/<webhookHash>

Description Delete the registered Webhook. HTTP Method , API endpoint DELETE /v1/users/<username>/webhooks/<webhookHash> Request Header Key Description X-USER-TOKEN [required] It is the authentication token specified at the time of user registration. Example $ c</webhookhash></username>…

POST - /v1/users/<username>/webhooks/<webhookHash>

Description Invoke the webhook registered in advance. It is used "timezone" setting as post date if Graph's "timezone" is specified, if not specified, calculates it in "UTC". HTTP Method , API endpoint POST /v1/users/<username>/webhooks/<webhookHash> Request Hea</webhookhash></username>…

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

Description Get all predefined webhooks definitions. HTTP Method , API endpoint GET /v1/users/<username>/webhooks Request Header Key Description X-USER-TOKEN [required] It is the authentication token specified at the time of user registration. Examp</username>…

POST - /v1/users/<username>/webhooks

Description Create a new Webhook. HTTP Method , API endpoint POST /v1/users/<username>/webhooks Request Header Key Description X-USER-TOKEN [required] It is the authentication token specified at the time of user registration. Request Body Key Type D</username>…

DELETE - /v1/users/<username>/graphs/<graphID>/<yyyyMMdd>

Description Delete the registered "Pixel". HTTP Method , API endpoint DELETE /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> Request Header Key Description X-USER-TOKEN [required] It is the authentication token specified at the time of user registration. Example $ cu</yyyymmdd></graphid></username>…

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

Description Decrement quantity "Pixel" of the day (it is used "timezone" setting if Graph's "timezone" is specified, if not specified, calculates it in "UTC"). If the graph type is int then -1 added, and for float then -0.01 added. HTTP Me…

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

Description Increment quantity "Pixel" of the day (it is used "timezone" setting if Graph's "timezone" is specified, if not specified, calculates it in "UTC"). If the graph type is int then 1 added, and for float then 0.01 added. HTTP Meth…

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

Description Update the quantity already registered as a "Pixel". If target "Pixel" not exist, create a new "Pixel" and set quantity. HTTP Method , API endpoint PUT /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> Request Header Key Description X-USER-TOKEN [required] </yyyymmdd></graphid></username>…

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

Description Get registered quantity as "Pixel". HTTP Method , API endpoint GET /v1/users/<username>/graphs/<graphID>/<yyyyMMdd> Request Header Key Description X-USER-TOKEN [required] It is the authentication token specified at the time of user registration. Example $ </yyyymmdd></graphid></username>…

POST - /v1/users/<username>/graphs/<graphID>

Description It records the quantity of the specified date as a "Pixel". HTTP Method , API endpoint POST /v1/users/<username>/graphs/<graphID> Request Header Key Description X-USER-TOKEN [required] It is the authentication token specified at the time of user </graphid></username>…

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

Description Based on the registered information, get various statistics. HTTP Method , API endpoint GET /v1/users/<username>/graphs/<graphID>/stats Example $ curl -X GET https://pixe.la/v1/users/a-know/graphs/test-graph/stats {"totalPixelsCount":4,"maxQuanti</graphid></username>…

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

Description Get a Date list of Pixel registered in the graph specified by graphID. You can specify a period with from and to parameters. If you do not specify both from andto; You will get a list of 365 days ago from today. If you specify …

GET - /v1/users/<username>/graphs/<graphID>.html

Description Displays the details of the graph in html format. HTTP Method , API endpoint GET /v1/users/<username>/graphs/<graphID>.html Query Parameter Key type Description mode string [optional] You can get a very simple html response by specifying simple o</graphid></username>…

DELETE - /v1/users/<username>/graphs/<graphID>

Description Update predefined pixelation graph definitions.The items that can be updated are limited as compared with the pixelation graph definition creation. HTTP Method , API endpoint DELETE /v1/users/<username>/graphs/<graphID> Request Header Key Descrip</graphid></username>…

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

Description Update predefined pixelation graph definitions.The items that can be updated are limited as compared with the pixelation graph definition creation. HTTP Method , API endpoint PUT /v1/users/<username>/graphs/<graphID> Request Header Key Descriptio</graphid></username>…

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

Description Based on the registered information, express the graph in SVG format diagram. HTTP Method , API endpoint GET /v1/users/<username>/graphs/<graphID> Query Parameter Key Description date string|[optional] If you specify it in yyyyMMdd format, will c</graphid></username>…

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

Description Get all predefined pixelation graph definitions. 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.</username>…