aboutsummaryrefslogtreecommitdiff
path: root/docs/api.rst
diff options
context:
space:
mode:
authorAlexis Métaireau <alexis@vieuxsinge.com>2018-08-05 14:37:50 +0200
committerAlexis Métaireau <alexis@vieuxsinge.com>2018-08-05 14:37:50 +0200
commit633e3543b24fb241135770afe0ca8bcd8ceae072 (patch)
tree33d5183816de8365efb94645b526b5a052d9e28c /docs/api.rst
parentc3b973b15e888263f6ca8538a72e39280a77ac3e (diff)
parent08bcf702b86d520b15cd8e9acee3b8df1fe9d07b (diff)
downloadihatemoney-mirror-633e3543b24fb241135770afe0ca8bcd8ceae072.zip
ihatemoney-mirror-633e3543b24fb241135770afe0ca8bcd8ceae072.tar.gz
ihatemoney-mirror-633e3543b24fb241135770afe0ca8bcd8ceae072.tar.bz2
Merge branch 'master' into almet/fix-pbkdf2-check
Diffstat (limited to 'docs/api.rst')
-rw-r--r--docs/api.rst22
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
+ }
+ ]