Skip to content
This repository was archived by the owner on Jun 11, 2024. It is now read-only.

Commit 0042c0f

Browse files
committed
Add reporting save parameter
1 parent cf91996 commit 0042c0f

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

CHANGES.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- :meth:`atomx.Atomx.search` takes ``index`` parameter to only search specific models.
66
- Add support to remove models from the API. See :meth:`atomx.models.AtomxModel.delete`.
77
- Add :meth:`atomx.Atomx.remove`.
8+
- Add ``save`` parameter to :meth:`atomx.Atomx.report`.
89

910
1.5
1011
---

atomx/__init__.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ def search(self, query, index=None):
146146

147147
def report(self, scope=None, groups=None, metrics=None, where=None, from_=None, to=None,
148148
timezone='UTC', emails=None, when=None, interval=None, name=None,
149-
sort=None, limit=None, offset=None):
149+
sort=None, limit=None, offset=None, save=True):
150150
"""Create a report.
151151
152152
See the `reporting atomx wiki <https://wiki.atomx.com/reporting>`_
@@ -162,7 +162,7 @@ def report(self, scope=None, groups=None, metrics=None, where=None, from_=None,
162162
An expression list is in the form of ``[column, op, value]``:
163163
164164
- ``column`` can be any of the ``groups`` or ``metrics`` parameter columns.
165-
- ``op`` can be any of ``==``, ``!=``, ``in`` or ``not in`` as a string.
165+
- ``op`` can be any of ``==``, ``!=``, ``<``, ``>``, ``in`` or ``not in`` as a string.
166166
- ``value`` is either a number or in case of ``in``
167167
and ``not in`` a list of numbers.
168168
@@ -181,9 +181,10 @@ def report(self, scope=None, groups=None, metrics=None, where=None, from_=None,
181181
:param str or list sort: List of columns to sort by.
182182
:param int limit: Number of rows to return
183183
:param int offset: Number of rows to skip.
184+
:param bool save: Should the report appear in the users report history (defaults to `True`).
184185
:return: A :class:`atomx.models.Report` model
185186
"""
186-
report_json = {'timezone': timezone}
187+
report_json = {'timezone': timezone, 'save': save}
187188

188189
if name:
189190
report_json['name'] = name

0 commit comments

Comments
 (0)