Export Campaigns
General export task contract
The general contract for creating an export task is described here.
Campaigns export contract
Example request
https://api.maestra.io/v3/operations/sync?endpointId={endpointId}&operation={operation}
Accept: application/json
Content-Type: application/json
Authorization: SecretKey {Secret key}
{
"sinceDateTimeUtc": "<Start date and time of the campaign change (UTC, YYYY-MM-DD hh:mm)>",
"tillDateTimeUtc": "<End date and time of the campaign change, exclusive (UTC, YYYY-MM-DD hh:mm)>"
}You can specify the following input parameters:
| Parameter | Description |
|---|---|
sinceDateTimeUtc | From date (UTC). The export includes only campaigns created or changed after this date. |
tillDateTimeUtc | To date (UTC). The export includes only campaigns created or changed before this date. |
Export file format
Base export field descriptions
{
"mailings": [
{
"name": "<Campaign name>",
"mailingUtmName": "<Campaign name for use in the UTM tag>",
"type": "<Campaign type>",
"channel": "<Campaign channel>",
"creationDateTimeUtc": "<Campaign creation date in the system, UTC>",
"lastChangedDateTimeUtc": "<Campaign last modified date, UTC>",
"ids": {
"systemName": "<Campaign system name>",
"id": "<Maestra ID>"
},
"subscriptionTopic": {
"name": "<Topic name>",
"ids": {
"externalId": "<Topic system name>"
}
},
"folder": {
"name": "<Folder name>",
"ids": {
"systemName": "<Folder system name>"
}
},
"brand": {
"name": "<Brand name>",
"ids": {
"systemName": "<Brand system name>"
}
},
"utm": {
"utmSource": "<utm_source value>",
"utmMedium": "<utm_medium value>",
"utmCampaign": "<utm_campaign value>",
"utmContent": "<utm_content value>"
},
"tags": [
{
"name": "<Tag name>",
"ids": {
"systemName": "<Tag system name>"
}
},
{
"name": "<Tag name>",
"ids": {
"systemName": "<Tag system name>"
}
}
]
}
]
}
Campaign typesThe
typefield can be one of three values:
Value Description massBulk campaign triggerAutomated campaign transactionTransactional campaign
Updated about 2 months ago

