Skip to content

Commit a656cf2

Browse files
committed
Add more info on l9event type
1 parent 9399004 commit a656cf2

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

leakix/client.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ def get(self, scope: Scope, queries: Optional[List[Query]] = None, page: int = 0
7474
7575
The output of a query can be accessed using the method `json`, for instance `response.json()`.
7676
In the case of a successfull response, the output will be a list of L9Event.
77+
When you have an object of type `l9Event` (or the longer
78+
`l9format.l9format.L9Event`), you can refer to
79+
[L9Event](https://github.com/LeakIX/l9format-python/blob/main/l9format/l9format.py#L158)
80+
model class for the available fields.
81+
For instance, to access the IP of an object `event` of type `L9Event`, you can
82+
use `event.ip`.
7783
"""
7884
if page < 0:
7985
raise ValueError("Page argument must be a positive integer")

0 commit comments

Comments
 (0)