diff options
| author | Jocelyn Delalande <jocelyn@crapouillou.net> | 2018-02-03 18:52:04 +0100 |
|---|---|---|
| committer | Jocelyn Delalande <jocelyn@crapouillou.net> | 2018-02-07 00:06:08 +0100 |
| commit | b95ea7f4e68a0794a44e68621a8210bb4db43e67 (patch) | |
| tree | 161190c22b4c6257d3a6839d610d865e0b63aa09 /docs/api.rst | |
| parent | 036cd05e5716a694f575b3c65f6541f04a8b48bf (diff) | |
| download | ihatemoney-mirror-b95ea7f4e68a0794a44e68621a8210bb4db43e67.zip ihatemoney-mirror-b95ea7f4e68a0794a44e68621a8210bb4db43e67.tar.gz ihatemoney-mirror-b95ea7f4e68a0794a44e68621a8210bb4db43e67.tar.bz2 | |
Add statistics support to API
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst index b82c6f3..0ae4214 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -164,3 +164,25 @@ And you can of course `DELETE` them at `/api/projects/<id>/bills/<bill-id>`:: $ curl --basic -u demo:demo -X DELETE\ https://ihatemoney.org/api/projects/demo/bills/80\ "OK" + + +Statistics +---------- + +You can get some project stats with a `GET` on `/api/projects/<id>/statistics`:: + + $ curl --basic -u demo:demo https://ihatemoney.org/api/projects/demo/statistics + [ + { + "balance": 12.5, + "member": {"activated": True, "id": 1, "name": "alexis", "weight": 1.0}, + "paid": 25.0, + "spent": 12.5 + }, + { + "balance": -12.5, + "member": {"activated": True, "id": 2, "name": "fred", "weight": 1.0}, + "paid": 0, + "spent": 12.5 + } + ] |