Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
reporting [2017/04/05 04:33]
daniel@atomx.com
reporting [2017/04/05 04:34] (current)
daniel@atomx.com [Table]
Line 43: Line 43:
 The JSON should be POSTed to [[http://​api.atomx.com/​v3/​report]]. The following parameters are accepted: The JSON should be POSTed to [[http://​api.atomx.com/​v3/​report]]. The following parameters are accepted:
  
-^ Parameter ​ ^ Value ^ Description ^ +^ Parameter ​ ^ Value                             ​^ Description ​                                                                                                                        ​
-^ sort      | `[column_name].[asc|desc]` | Sorting ascending or descending on column names | +^ sort       ​| `[column_name].[asc|desc]` ​       | Sorting ascending or descending on column names                                                                                     ​
-^ limit      | number | Specify the number of rows to return. 0 or omitted means unlimited | +^ limit      | number ​                           | Specify the number of rows to return. 0 or omitted means unlimited ​                                                                 
-^ offset ​     | number | Specify the row to start at. Default is 0 | +^ offset ​    ​| number ​                           | Specify the row to start at. Default is 0                                                                                           ​
-^ download ​     | none or [excel,excel-tab,unix] | Download the report as CSV instead of inside JSON. If a string is provided, export in specified dialect. Defaults to '​excel'​ (CSV) | +^ download ​  ​| none or `[excel|excel-tab|unix]`  ​| Download the report as CSV instead of inside JSON. If a string is provided, export in specified dialect. Defaults to '​excel'​ (CSV)  
-^ save      | none or `[true|false]` | Should the report be saved in the users report history. Defaults to `true` | +^ save       ​| none or `[true|false]` ​           | Should the report be saved in the users report history. Defaults to `true` ​                                                         
-^ editable ​     | none or `[true|false]` | Should other users be able to change the date range of this report. Defaults to `false` |+^ editable ​  ​| none or `[true|false]` ​           | Should other users be able to change the date range of this report. Defaults to `false` ​                                            ​|
  
 This will return a JSON like: This will return a JSON like: