Campaigns
List CampaignSends
Returns a paginated list of send records for the given Campaign.
get/shop/customers/campaigns/{campaignId}/sends
Query parameters
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
querystring
Filters sends whose recipient customer name or email contains the given value.
sentboolean
When true, only sends that have been sent are returned. When false, only unsent sends are returned.
failedboolean
When true, only sends that have failed are returned. When false, only non-failed sends are returned.
bouncedboolean
When true, only sends that have bounced are returned. When false, only non-bounced sends are returned.
Response
The campaign sends were successfully retrieved.
Example response
{
"data": [
{
"subject": "Exclusive summer offer just for you",
"customer": {
"first_name": "Jane",
"last_name": "Doe",
"email": "janedoe@example.com"
}
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.