Add Track Statistics API

Author: wenhui-wd

apiary.apib

@@ -355,6 +355,57 @@ Report APIs
             "description":"Unknown server error. Please contact support."
         }
 
++ Response 503 (application/json)
+
+        {
+            "name":"Service Unavailable",
+            "value":"503",
+            "description":"Servers are up but overloaded. Try again later."
+        }
+        
+## Track Statistics [/reports/{track}?startDate={startDate}&endDate={endDate}]
+### Track Statistics [GET]
+
++ Parameters
+    + track (required, string, `design`) ... Track Name. Only allow "Design", "Develop" and "Data"
+    + startDate (optional, string, `2013-01-01`) ... timespan start date
+    + endDate (optional, string, `2014-01-01`) ... timespan end date
+
++ Response 200 (application/json)
+
+        {
+            "numberOfRunningChallenges": 10,
+            "totalPrizeOfRunningChallenges": 13500,
+            "totalPrizeInGivenTime": 120000,
+            "numberOfChallengesInGivenTime": 100,
+            "numberOfRegisteredUsers": 90,
+            "numberOfActiveUsers": 50
+        }
+
++ Response 400 (application/json)
+
+        {
+            "name":"Bad Request",
+            "value":"400",
+            "description":"This message will explain why the request is invalid or cannot be served."
+        }
+
++ Response 404 (application/json)
+
+        {
+            "name":"Not Found",
+            "value":"404",
+            "description":"This message will explain why the URI requested is invalid or the resource does not exist."
+        }
+
++ Response 500 (application/json)
+
+        {
+            "name":"Internal Server Error",
+            "value":"500",
+            "description":"Unknown server error. Please contact support."
+        }
+
 + Response 503 (application/json)
 
         {