Campaigns

Get a campaign run

Returns a single run of a campaign by its identifier.

get/v1/campaigns/{id}/runs/{runId}

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/campaigns/{id}/runs/{runId}
  • Auth: API key in header x-api-key

Path parameters

idstring required
runIdstring required

Response

CampaignRun

idstring required
campaignIdstring required
status'scheduled' | 'resolving' | 'dispatching' | 'paused' | 'completed' | 'cancelled' | 'failed' required
scheduledForstring required
idempotencyKeystring nullable required
startedAtstring nullable required
completedAtstring nullable required
totalRecipientsnumber required
dispatchedCountnumber required
failedCountnumber required
skippedCountnumber required
pendingCountnumber required
estimatedCompletionAtstring nullable required
failureReasonstring nullable required
holdReasonstring nullable required
holdDomainIdstring required
holdUntilstring nullable required
capacityWarningstring nullable required
lastContactIdstring nullable required
createdBystring nullable required
actorEmailstring required
memberRolestring required
createdAtstring required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.