From ee1eee4caa5073169e2a06e0edba7cc169054189 Mon Sep 17 00:00:00 2001 From: tjnet Date: Sat, 18 Apr 2015 23:41:15 +0900 Subject: [PATCH] add docs for statistics API --- docs/api/stats.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+), 0 deletions(-) create mode 100644 docs/api/stats.md diff --git a/docs/api/stats.md b/docs/api/stats.md new file mode 100644 index 0000000..081cfd1 --- /dev/null +++ b/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://localhost:8080/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 +} + +``` -- libgit2 0.21.2