# ScheduledEmailById Fetch scheduled emails by batchId or messageId Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old) - Catalog: `Brevo` - Schema: `TransactionalEmails` This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `ScheduledEmailById`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `endDate` | `` | ☐ | | Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | | `identifier` | `` | ☑ | | The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored. | | `startDate` | `` | ☐ | | Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date. | | `status` | `` | ☐ | | Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`. (Values: processed, inProgress, queued) | ## Columns of Table Function The columns of the table function `ScheduledEmailById` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `count` | `int64` | Count | ☐ | Total number of batches | | `createdAt` | `datetime` | Creation Date | ☐ | Datetime on which the email was scheduled | | `scheduledAt` | `datetime` | Schedule Date | ☐ | Datetime for which the email was scheduled | | `status` | `varchar2` | Status | ☐ | Current status of the scheduled email |