Exporting Mailing-Related Actions
Method Description
Invoked with a POST request. Operation name is set up via Maestra framework. Details of method invocation can be found here.
POST https://api.maestra.io/v3/operations/sync?endpointId={unique ID of site/mobile app/etc.}&operation={operation name}
Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Secret Key}
{
"sinceDateTimeUtc": "<Timestamp of the earliest action (UTC, YYYY-MM-DD hh:mm)>",
"tillDateTimeUtc": "<Timestamp of the latest action (UTC, YYYY-MM-DD hh:mm)>",
"segment": {
"ids": {
"externalId": "<Segment external ID>"
}
}
}
Response
{
"customerActions": [
{
"dateTimeUtc": "<Action date (UTC+0)>",
"creationDateTimeUtc": "<Action creation timestamp (UTC)>",
"ids": {
"customerActionId": "<Maestra id>"
},
"actionTemplate": {
"name": "<Action template name>",
"ids": {
"systemName": "<Action template system name>"
}
},
"channel": {
"name": "<Touchpoint name>",
"utmCampaign": "<UTM_campaign value>",
"utmSource": "<UTM_source value>",
"utmMedium": "<utm_medium value>",
"utmContent": "<utm_content value>",
"utmTerm": "<UTM_term value>",
"ids": {
"pointOfContactId": "<Maestra id>",
"externalId": "<Touchpoint external ID>",
"systemName": "<Touchpoint external ID>"
}
},
"mailing": {
"action": "<Event in mailing>",
"name": "<Mailing name>",
"link": "<Link>",
"ids": {
"systemName": "<Mailing system name>",
"id": "<Maestra id>",
"variantNum": "<Mailing variant number>"
},
"notSentReason": {
"name": "<Status description, reason why message wasn't sent>",
"ids": {
"systemName": "<Unsent status system name>"
}
},
"notDeliveredReason": {
"name": "<Delivery fail status description>",
"ids": {
"systemName": "<Delivery fail status system name>"
}
}
},
"brand": {
"ids": {
"systemName": "<Brand system name>"
}
},
"customer": {
"ids": {
"customerId": "<Maestra id>"
}
},
"rootAction": {
"ids": {
"customerActionId": "<Root action ID in Maestra>"
},
"actionTemplate": {
"name": "<Action template name>",
"ids": {
"systemName": "<Action template system name>"
}
}
}
},
{
"dateTimeUtc": "<Action date (UTC+0)>",
"creationDateTimeUtc": "<Action creation timestamp (UTC)>",
"ids": {
"customerActionId": "<Maestra id>"
},
"actionTemplate": {
"name": "<Action template name>",
"ids": {
"systemName": "<Action template system name>"
}
},
"channel": {
"name": "<Touchpoint name>",
"utmCampaign": "<UTM_campaign value>",
"utmSource": "<UTM_source value>",
"utmMedium": "<utm_medium value>",
"utmContent": "<utm_content value>",
"utmTerm": "<UTM_term value>",
"ids": {
"pointOfContactId": "<Maestra id>",
"externalId": "<Touchpoint external ID>",
"systemName": "<Touchpoint external ID>"
}
},
"mailing": {
"action": "<Event in mailing>",
"name": "<Mailing name>",
"link": "<Link>",
"ids": {
"systemName": "<Mailing system name>",
"id": "<Maestra id>",
"variantNum": "<Mailing variant number>"
},
"notSentReason": {
"name": "<Status description, reason why message wasn't sent>",
"ids": {
"systemName": "<Unsent status system name>"
}
},
"notDeliveredReason": {
"name": "<Delivery fail status description>",
"ids": {
"systemName": "<Delivery fail status system name>"
}
}
},
"brand": {
"ids": {
"systemName": "<Brand system name>"
}
},
"customer": {
"ids": {
"customerId": "<Maestra id>"
}
},
"rootAction": {
"ids": {
"customerActionId": "<Root action ID in Maestra>"
},
"actionTemplate": {
"name": "<Action template name>",
"ids": {
"systemName": "<Action template system name>"
}
}
}
}
]
}
Mailing-Related Actions
Business meaning | Action |
---|---|
Mailing | Dispatch |
Mailing sent | MailingSend |
Mailing opened | MailingOpen |
Mailing not sent | MailingNotSent |
Mailing not delivered | MailingNotDelivered |
Mailing link clicked | MailingClick |
Participation in mailing | WaitingForDispatch |
Mailing unsubscribe request | MailingUnsubscribe |
Control group | ControlGroup |
Updated about 1 month ago