explanations of queryparams

This commit is contained in:
Catherine Heywood
2016-05-19 14:49:32 +01:00
parent 2b5f881d44
commit 9e647be35c

View File

@@ -306,11 +306,11 @@ where:
* `next` is the URL of the next page of notifications * `next` is the URL of the next page of notifications
These URLs accept the following query string parameters: These URLs accept the following query string parameters:
* `template_type` * `template_type` - `sms` or `email` (you can enter both)
* `status` * `status` - `sending`, `delivered`, or `failed`
* `page` * `page` - page number
* `page_size` * `page_size`
* `limit_days` * `limit_days` - defaults to 7
* `total` is the total number of notifications sent by the service using the given template type * `total` is the total number of notifications sent by the service using the given template type
* `page_size` is an optional integer indicating the number of notifications per page; if not provided, defaults to 50 * `page_size` is an optional integer indicating the number of notifications per page; if not provided, defaults to 50