Stats

The stats endpoint gives the ability to get some basic stats about your company in Picqer. Useful to present on a status dashboard for example.

Get list of possible stats

This endpoint gives a list of all the current available stats. The endpoint for the stats itself is /api/v1/stats/{key-of-report}.

GET https://example.picqer.com/api/v1/stats
HTTP/1.1 200 OK { "open-picklists": { "description":"Number of open picklists" }, "open-orders": { "description":"Number of open orders" }, "new-orders-today": { "description":"Number of new orders created today" }, "new-orders-this-week": { "description":"Number of new orders created this week" }, "backorders": { "description":"Number of current backorders" }, "new-customers-this-week": { "description":"Number of new customers this week" } }

Get a single stat

Use the key of the report description as endpoint to get the stat.

GET https://example.picqer.com/api/v1/stats/{key}
HTTP/1.1 200 OK { "value":14 }

Get a single stat for Geckoboard

Geckoboard expects a specific format for stats. If you add querystring param style=geckboard you can get the stat formatted for Geckoboard.

GET https://example.picqer.com/api/v1/stats/{key}?style=geckoboard
HTTP/1.1 200 OK { "item": [ { "text":"", "value":14 } ] }