guides/developer/REST-API.md

@@ -3,6 +3,7 @@
   * [List scans](#list-scans)
   * [Perform a new scan](#perform-a-new-scan)
   * [Monitor scan progress](#monitor-scan-progress)
+      * [Summary](#monitor-scan-progress-summary)
   * [Pause a scan](#pause-a-scan)
   * [Resume a scan](#resume-a-scan)
   * [Retrieve a scan report](#retrieve-a-scan-report)
@@ -232,6 +233,50 @@ So long as the client maintains a session with the service, only new `issues`, `
 entries and `errors` will be returned.
 If no session is being maintained, each call will always return all data.
 
+#### <a id="monitor-scan-progress-summary" href="#monitor-scan-progress-summary">Summary</a>
+
+Returns the same data as "[Monitor scan progress](#monitor-scan-progress)" but without `issues`, `errors` and `sitemap`.
+
+##### Request
+
+    GET /scans/:id/summary
+
+##### Response
+
+```json
+{
+  "status": "scanning",
+  "busy": true,
+  "seed": "c0c039750bef4f5688da4fba929b06ac",
+  "statistics": {
+    "http": {
+      "request_count": 1312,
+      "response_count": 1208,
+      "time_out_count": 0,
+      "total_responses_per_second": 145.55173283136,
+      "burst_response_time_sum": 0,
+      "burst_response_count": 0,
+      "burst_responses_per_second": 0,
+      "burst_average_response_time": 0,
+      "total_average_response_time": 0.12118887582781,
+      "max_concurrency": 20,
+      "original_max_concurrency": 20
+    },
+    "browser_cluster": {
+      "seconds_per_job": 1.6666666666667,
+      "total_job_time": 25,
+      "queued_job_count": 31,
+      "completed_job_count": 15
+    },
+    "runtime": 9.251885252,
+    "found_pages": 10,
+    "audited_pages": 2,
+    "current_page": "http:\/\/testhtml5.vulnweb.com\/ajax\/popular?offset=0"
+  },
+  "messages": []
+}
+```
+
 ### <a id="pause-a-scan" href="#pause-a-scan">Pause a scan</a>
 
 This is a soft pause, it will not kill the scanner process but merely make it