Skip to content

Commit fc23333

Browse files
authored
docs: Document default value of limit parameter in events (#796)
Closes: SDK-2912
1 parent f1a0aa4 commit fc23333

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

boxsdk/object/events.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ def get_admin_events(
108108
stream type. Used for historical querying (up to one year). Works for Enterprise admin_logs type.
109109
110110
:param limit:
111-
(optional) Maximum number of events to return.
111+
(optional) Maximum number of events to return. If None, default API value limit=100 will be used.
112112
:param stream_position:
113113
The location in the stream from which to start getting events. 0 is the beginning of time.
114114
:param created_after:

docs/usage/events.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ for event in events['entries']:
101101
### Get Admin Events
102102

103103
The SDK also allows you to retrieve enterprise events. Use [`events.get_admin_events_streaming(self, limit=None, stream_position=0, event_types=None)`] for live monitoring (events up to two weeks, low latency) and [`events.get_admin_events(self, limit=None, stream_position=0, created_after=None, created_before=None, event_types=None)`] for historical querying (events up to one year, higher latency).
104-
104+
If `limit` param is set to None, then default API value (limit=100) will be used.
105105
Live monitoring example
106106

107107
<!-- sample get_events enterprise_stream -->
@@ -124,6 +124,7 @@ Addditionally, a list of event types can be passed along to filter down the retu
124124

125125
When using historical querying you can specify before and after a certain datetime and the types of events to retrieve with the `event_type` by calling
126126
[`events.get_admin_events(self, limit=None, stream_position=0, created_after=None, created_before=None, event_types=None)`][admin_events_details].
127+
If `limit` param is set to None, then default API value (limit=100) will be used.
127128
The format for the `created_after` and `created_before` fields are supported by [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) and look
128129
something like this: 2019-08-12T09:12:36-00:00. For more information on the date format please see [here](https://developer.box.com/en/guides/api-calls/types-and-formats/#date-and-times).
129130
This method returns a `dict` with the relevant [`Event`][event_class] objects in a `list` under the

0 commit comments

Comments
 (0)