@@ -57,10 +57,29 @@ def list_environment_sessions(
5757 timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
5858 ) -> SyncSessionsPage [EnvironmentSession ]:
5959 """
60- Lists environment sessions within a specified date range.
60+ Lists completed environment sessions within a specified date range.
6161
62- Returns a list of environment sessions that were active within the specified
63- date range.
62+ Returns a list of environment sessions that were completed within the specified
63+ date range. Currently running sessions are not included.
64+
65+ Use this method to:
66+
67+ - View environment sessions
68+ - Filter by project
69+ - Monitor session activity
70+ - Create custom usage reports
71+
72+ ### Example
73+
74+ ```yaml
75+ filter:
76+ projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
77+ dateRange:
78+ startTime: "2024-01-01T00:00:00Z"
79+ endTime: "2024-01-02T00:00:00Z"
80+ pagination:
81+ pageSize: 100
82+ ```
6483
6584 Args:
6685 filter: Filter options.
@@ -138,10 +157,29 @@ def list_environment_sessions(
138157 timeout : float | httpx .Timeout | None | NotGiven = NOT_GIVEN ,
139158 ) -> AsyncPaginator [EnvironmentSession , AsyncSessionsPage [EnvironmentSession ]]:
140159 """
141- Lists environment sessions within a specified date range.
160+ Lists completed environment sessions within a specified date range.
161+
162+ Returns a list of environment sessions that were completed within the specified
163+ date range. Currently running sessions are not included.
164+
165+ Use this method to:
166+
167+ - View environment sessions
168+ - Filter by project
169+ - Monitor session activity
170+ - Create custom usage reports
171+
172+ ### Example
142173
143- Returns a list of environment sessions that were active within the specified
144- date range.
174+ ```yaml
175+ filter:
176+ projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
177+ dateRange:
178+ startTime: "2024-01-01T00:00:00Z"
179+ endTime: "2024-01-02T00:00:00Z"
180+ pagination:
181+ pageSize: 100
182+ ```
145183
146184 Args:
147185 filter: Filter options.
0 commit comments