Merge pull request #872 from tjnet/479_add_docs_for_stats_api

add docs for statistics API

Merge pull request #872 from tjnet/479_add_docs_for_stats_api
add docs for statistics API
Stephen Crosby
2 parents eedfabc0 0359a044
Showing 1 changed file with 36 additions and 0 deletions Show diff stats
docs/api/stats.md
@@ -0,0 +1,36 @@
+# Statistics API Documentation
+
+
+## Get Stats
+
+Represent error statistics. Render JSON if no extension specified on path.
+
+
+### Request
+
+Example:
+
+```sh
+
+curl 'http://myerrbit.com/api/v1/stats/app?api_key=6423d563e5285b34cb117f757b2bc7b1'
+
+```
+
+Parameters:
+
+- **api_key** - required, this endpoints require authentication with an API Key.
+
+
+### Response
+
+
+```javascript
+
+{
+  name: "sample app",
+  id: "552941336a756e4e71012345",
+  last_error_time: "2015-04-12T08:43:47.480+00:00",
+  unresolved_errors: 4
+}
+
+```
@@ -0,0 +1,36 @@		@@ -0,0 +1,36 @@
	1	+# Statistics API Documentation
	2	+
	3	+
	4	+## Get Stats
	5	+
	6	+Represent error statistics. Render JSON if no extension specified on path.
	7	+
	8	+
	9	+### Request
	10	+
	11	+Example:
	12	+
	13	+```sh
	14	+
	15	+curl 'http://myerrbit.com/api/v1/stats/app?api_key=6423d563e5285b34cb117f757b2bc7b1'
	16	+
	17	+```
	18	+
	19	+Parameters:
	20	+
	21	+- api_key - required, this endpoints require authentication with an API Key.
	22	+
	23	+
	24	+### Response
	25	+
	26	+
	27	+```javascript
	28	+
	29	+{
	30	+ name: "sample app",
	31	+ id: "552941336a756e4e71012345",
	32	+ last_error_time: "2015-04-12T08:43:47.480+00:00",
	33	+ unresolved_errors: 4
	34	+}
	35	+
	36	+```