POST /admin/api/{api_version}/marketing_events/{marketing_event_id}/engagements.json
Engagements on marketing events represent customer activity taken on the marketing event before customers reach the shop’s website. Not all types of marketing events will necessarily have engagement, and most types of marketing events will only use a subset of the possible engagement types.
Engagements are aggregated on a daily basis. However, the data can be sent more often than once a day if the information is available. If you create an engagement with the same value for occurred_on as an existing engagement, then the new engagement will overwrite the previous one.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
marketing_event_id |
String | Yes | |
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-shopify-access-token |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
engagements[] |
Array | No | |
engagements[].ad_spend |
Number | No | |
engagements[].clicks_count |
Number | No | |
engagements[].occurred_on |
String | No | |
engagements[].is_cumulative |
Boolean | No | |
engagements[].views_count |
Number | No | |
engagements[].favorites_count |
Number | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.