You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A date/time value accepted as either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` (e.g. `2024-01-15`, `last monday`).
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/HistoryApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -171,8 +171,8 @@ with openapi_client.ApiClient(configuration) as api_client:
171
171
delivered =1# int | Filter by delivery status. `1` returns only messages that were successfully delivered to the destination MX. `0` returns messages that are still queued, deferred, or failed. Omit to return all messages regardless of delivery status. (optional)
172
172
skip =0# int | Number of records to skip for pagination. Use in combination with `limit` to page through large result sets. Defaults to `0` (no skip). (optional) (default to 0)
173
173
limit =100# int | Maximum number of records to return per page. Defaults to `100`. Maximum allowed value is `10000`. The response also includes a `total` field with the full matched count so you can calculate the number of pages. (optional) (default to 100)
174
-
start_date = openapi_client.ViewMailLogStartDateParameter() #ViewMailLogStartDateParameter | Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included. (optional)
175
-
end_date = openapi_client.ViewMailLogStartDateParameter() #ViewMailLogStartDateParameter | Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included. (optional)
174
+
start_date = openapi_client.DateOrTimestamp() #DateOrTimestamp | Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included. (optional)
175
+
end_date = openapi_client.DateOrTimestamp() #DateOrTimestamp | Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included. (optional)
176
176
sort = time # str | Field to sort results by. Currently only `time` is supported (sorts by internal row ID which corresponds to chronological order). (optional) (default to time)
177
177
dir= desc # str | Sort direction. `desc` returns newest first (default), `asc` returns oldest first. (optional) (default to desc)
178
178
groupby = recipient # str | Controls how results are grouped. `recipient` (default) returns one row per delivery attempt — a message sent to 4 recipients produces 4 rows, each with its own `recipient`, `delivered`, `response`, and delivery metadata. `message` collapses to one row per unique message ID; delivery-level fields will reflect one arbitrary recipient per message. The `total` count in the response matches the grouping mode. (optional) (default to recipient)
@@ -206,8 +206,8 @@ Name | Type | Description | Notes
206
206
**delivered** | **int**| Filter by delivery status. `1` returns only messages that were successfully delivered to the destination MX. `0` returns messages that are still queued, deferred, or failed. Omit to return all messages regardless of delivery status. | [optional]
207
207
**skip** | **int**| Number of records to skip for pagination. Use in combination with `limit` to page through large result sets. Defaults to `0` (no skip). | [optional][default to 0]
208
208
**limit** | **int**| Maximum number of records to return per page. Defaults to `100`. Maximum allowed value is `10000`. The response also includes a `total` field with the full matched count so you can calculate the number of pages. | [optional][default to 100]
209
-
**start_date** | [**ViewMailLogStartDateParameter**](.md)| Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included. | [optional]
210
-
**end_date** | [**ViewMailLogStartDateParameter**](.md)| Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included. | [optional]
209
+
**start_date** | [**DateOrTimestamp**](.md)| Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included. | [optional]
210
+
**end_date** | [**DateOrTimestamp**](.md)| Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included. | [optional]
211
211
**sort** | **str**| Field to sort results by. Currently only `time` is supported (sorts by internal row ID which corresponds to chronological order). | [optional][default to time]
212
212
**dir** | **str**| Sort direction. `desc` returns newest first (default), `asc` returns oldest first. | [optional][default to desc]
213
213
**groupby** | **str**| Controls how results are grouped. `recipient` (default) returns one row per delivery attempt — a message sent to 4 recipients produces 4 rows, each with its own `recipient`, `delivered`, `response`, and delivery metadata. `message` collapses to one row per unique message ID; delivery-level fields will reflect one arbitrary recipient per message. The `total` count in the response matches the grouping mode. | [optional][default to recipient]
**time** | **str** | The time window these `received`, `sent`, and `volume` statistics cover. | [optional][default to '1h']
9
+
**time** | **str** | The time window these `received`, `sent`, and `volume` statistics cover. | [optional][default to OneHour]
10
10
**usage** | **int** | Total messages accepted during the current billing cycle. Used to calculate the `cost` value. | [optional]
11
11
**currency** | **str** | The ISO 4217 currency code for this account (e.g. `USD`). | [optional]
12
12
**cost** | **float** | Estimated cost for the current billing cycle combining the base plan price and per-email charges ($0.20/1000 emails). | [optional]
Copy file name to clipboardExpand all lines: openapi_client/api/history_api.py
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -371,9 +371,9 @@ def view_mail_log(
371
371
:param limit: Maximum number of records to return per page. Defaults to `100`. Maximum allowed value is `10000`. The response also includes a `total` field with the full matched count so you can calculate the number of pages.
372
372
:type limit: int
373
373
:param start_date: Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included.
374
-
:type start_date: ViewMailLogStartDateParameter
374
+
:type start_date: DateOrTimestamp
375
375
:param end_date: Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included.
376
-
:type end_date: ViewMailLogStartDateParameter
376
+
:type end_date: DateOrTimestamp
377
377
:param sort: Field to sort results by. Currently only `time` is supported (sorts by internal row ID which corresponds to chronological order).
:param limit: Maximum number of records to return per page. Defaults to `100`. Maximum allowed value is `10000`. The response also includes a `total` field with the full matched count so you can calculate the number of pages.
509
509
:type limit: int
510
510
:param start_date: Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included.
511
-
:type start_date: ViewMailLogStartDateParameter
511
+
:type start_date: DateOrTimestamp
512
512
:param end_date: Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included.
513
-
:type end_date: ViewMailLogStartDateParameter
513
+
:type end_date: DateOrTimestamp
514
514
:param sort: Field to sort results by. Currently only `time` is supported (sorts by internal row ID which corresponds to chronological order).
:param limit: Maximum number of records to return per page. Defaults to `100`. Maximum allowed value is `10000`. The response also includes a `total` field with the full matched count so you can calculate the number of pages.
646
646
:type limit: int
647
647
:param start_date: Earliest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-15` or `last monday`. Messages with a `time` value **greater than or equal to** this value will be included.
648
-
:type start_date: ViewMailLogStartDateParameter
648
+
:type start_date: DateOrTimestamp
649
649
:param end_date: Latest date to include. Accepts either a Unix timestamp (integer seconds since epoch) or a date string parseable by `strtotime()` such as `2024-01-31` or `yesterday`. Messages with a `time` value **less than or equal to** this value will be included.
650
-
:type end_date: ViewMailLogStartDateParameter
650
+
:type end_date: DateOrTimestamp
651
651
:param sort: Field to sort results by. Currently only `time` is supported (sorts by internal row ID which corresponds to chronological order).
0 commit comments