Web API is used for complex integrations and allows using Dashly at full power.


Web API is REST style.
All methods are described in the endpoints section.
Base URL: https://api.dashly.app.
We recommend using API via HTTPS protocol. You can use insecure HTTP protocol in case HTTPS is unavailable, but we might restrict API to HTTPS in the future.

Request parameters

Arguments can be sent as GET or POST parameters. UTF-8 encoding is used.

Arrays and objects have to be JSON-encoded between passing it to API (use JSON.stringify() or something alike).
Single-dimension arrays which contain only strings or numbers can be passed with "over comma" style. For example, param=1,2,3 or param=a,b,c.

API responses

All answers are JSON-objects. Special "envelope" is used:

  "meta": {
    "status": 200
  "data": {

meta section contains additional information for developers.

status field duplicates HTTP status code. Status 200 means a successful request.
Any other status means an error.

Error answer example:

  "meta": {
    "status": 400,
    "error_message": "The request could not be understood by the server due to malformed syntax",
    "error": "BadRequest"
  "data": {}

Here status field contains error HTTP-code (400). There are also error field (short error name) and error_message (human-readable error description).

Error description can be found in general errors section or concrete method page.