Sendinblue API Data Model
CouponCollections |
Get all your coupon collectionsRetrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).
Catalog: Brevo
Schema: Coupons
Primary Keys: id
Retrieve: true
Insert: true
Update: false
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function CouponCollections. 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 |
|---|---|---|---|---|
sortBy |
|
☐ |
|
The field used to sort coupon collections (Values: createdAt, remainingCoupons, expirationDate) |
Columns of Table Function
The columns of the table function CouponCollections are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
createdAt |
datetime |
Creation Date |
☐ |
Datetime on which the collection was created. |
defaultCoupon |
varchar2 |
|
☐ |
The default coupon of the collection. |
expirationDate |
datetime |
|
☐ |
Expiration date for the coupon collection in RFC3339 format. |
id |
varchar2 |
ID |
☐ |
The id of the collection. |
name |
varchar2 |
Name |
☐ |
The name of the collection. |
remainingCoupons |
int64 |
|
☐ |
Number of coupons that have not been sent yet. |
remainingCouponsAlert |
int64 |
|
☐ |
If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold. |
remainingDaysAlert |
int64 |
|
☐ |
If present, an email notification is going to be sent the defined amount of days before to the expiration date. |
totalCoupons |
int64 |
|
☐ |
Total number of coupons in the collection. |
