From b95ea7f4e68a0794a44e68621a8210bb4db43e67 Mon Sep 17 00:00:00 2001
From: Jocelyn Delalande <jocelyn@crapouillou.net>
Date: Sat, 3 Feb 2018 18:52:04 +0100
Subject: Add statistics support to API

---
 docs/api.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'docs')

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
+        }
+    ]
-- 
cgit v1.1