[incubator-ponymail-site] branch asf-site updated: Add some missing stats options

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-site.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new 494b8b3  Add some missing stats options
494b8b3 is described below

commit 494b8b3e7bb287deac9085124dd8a823ae444080
Author: Sebb <se...@apache.org>
AuthorDate: Sun May 2 12:12:06 2021 +0100

    Add some missing stats options
---
 source/markdown/docs/API.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/source/markdown/docs/API.md b/source/markdown/docs/API.md
index 0d868a1..0ff530e 100644
--- a/source/markdown/docs/API.md
+++ b/source/markdown/docs/API.md
@@ -38,13 +38,15 @@ Response example:
 
 ### Fetching list data
 Usage:
-`GET /api/stats.lua?list=$list&domain=$domain[&d=$timespan][&q=$query][&header_from=$from][&header_to=$to][&header_subject=$subject][&header_body=$body][&quick][&s=$s&e=$e]`
+`GET /api/stats.lua?list=$list&domain=$domain[&d=$timespan][&q=$query][&header_from=$from][&header_to=$to][&header_subject=$subject][&header_body=$body][&quick][&emailsOnly][&s=$s&e=$e]`
+
+See below for details of [timespan](#Timespans) values
 
 Parameters:
 
     - $list: The list prefix (e.g. `dev`). Wildcards may be used
     - $domain: The list domain (e.g. `httpd.apache.org`). Wildcards may be used
-    - $timespan: A [timespan](#Timespans) value
+    - $timespan: A timespan value (see below)
     - $s: yyyy-mm start of month (day 1)
     - $e: yyyy-mm end of month (last day)
     - $query: A search query (may contain wildcards or negations):
@@ -55,6 +57,8 @@ Parameters:
     - $to: Optional To: address
     - $subject: Optional Subject: line
     - $body: Optional body text
+    - quick: send statistics only (exclude emails, participants, threadstruct, word-cloud)
+    - emailsOnly: return email summaries only (omit thread_struct, top 10 participants and word-cloud)
     
 Response example: