import type * as Brevo from "../../../../index.js"; /** * @example * {} */ export interface GetEmailCampaignsRequest { /** Filter on the type of the campaigns */ type?: Brevo.GetEmailCampaignsRequestType; /** Filter on the status of the campaign */ status?: Brevo.GetEmailCampaignsRequestStatus; /** Filter on the type of statistics required. Example: **globalStats** value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the **Get Campaign Report** endpoint. */ statistics?: Brevo.GetEmailCampaignsRequestStatistics; /** **Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future. */ startDate?: string; /** **Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result.** Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future. */ endDate?: string; /** Number of documents per page */ limit?: number; /** Index of the first document in the page */ offset?: number; /** Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed */ sort?: Brevo.GetEmailCampaignsRequestSort; /** Use this flag to exclude htmlContent from the response body. If set to **true**, the htmlContent field will be returned as an empty string in the response body. */ excludeHtmlContent?: boolean; /** Use this flag to filter out campaigns that have a PDF attachment. If set to **true**, only campaigns without a PDF attachment (or with no attachment at all) will be returned. */ excludePdfAttachment?: boolean; }