Campaigns
List campaign runs
Returns a paginated list of runs for a campaign, optionally filtered by status. Use this endpoint to list campaign runs through the Samva email API.
Returns a paginated list of runs for a campaign, optionally filtered by status.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^camp_[0-9a-hjkmnp-tv-z]{16,24}$Query Parameters
status?|null
page?string|null
limit?string|null
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/campaigns/string/runs"{ "items": [ { "id": "string", "campaignId": "string", "status": "scheduled", "scheduledFor": "string", "idempotencyKey": "string", "startedAt": "string", "completedAt": "string", "contentSnapshot": { "channel": "email", "email": { "subject": "string", "html": "string", "text": "string", "attachments": [ { "filename": "string", "content": "string", "mediaId": "string", "contentType": "string", "size": 1 } ], "publicationId": "string", "inputContractId": "string", "templateId": "string", "templateSlug": "string", "templateData": {}, "inReplyToMessageId": "string", "replyTo": [ "string" ], "unsubscribeGroupId": "string", "tracking": { "opens": true, "clicks": true }, "footer": { "enabled": true } }, "conversationId": "string", "metadata": {} }, "audienceSnapshot": { "includeTags": [ "string" ], "excludeTags": [ "string" ], "contactIds": [ "string" ], "groupIds": [ "string" ] }, "policySnapshot": { "unsubscribeGroupId": "string", "pageSize": 100 }, "totalRecipients": 0, "dispatchedCount": 0, "failedCount": 0, "skippedCount": 0, "failureReason": "string", "lastContactId": "string", "createdBy": "string", "actorEmail": "string", "memberRole": "string", "createdAt": "string", "updatedAt": "string" } ], "pagination": { "page": 0, "limit": 0, "total": 0, "totalPages": 0 }}