Campaigns

Get a campaign by ID

Retrieves detailed information about a specific campaign including settings, schedule, statistics, and email counts. schedule.daysSchedule is one comma-separated string of weekday numbers, such as "1,2,3,4,5", not an array. minimumHealth lists each connected email account on the campaign with its health score and whether the campaign's minimum health score (settings.minimumHealthScore) holds it back; when every account is held back, allHeldBack is true and message says the campaign is sending nothing.

get/campaigns/{id}

Request

Base URL: https://api.emailchaser.com/r
URL: https://api.emailchaser.com/r/campaigns/{id}
Auth: HTTP bearer

Path parameters

idinteger required

Campaign ID

Response

Campaign details

createdAtstring

emojistring

flowstring

idinteger

launchAtstring

"0001-01-01T00:00:00Z" until the campaign is first launched.

namestring

sendAtstring

"0001-01-01T00:00:00Z" while not set.

statusstring

timezonestring

updatedAtstring

Example response

{
  "createdAt": "2024-01-10T10:30:00Z",
  "emails": {
    "blocked": 2,
    "bounced": 20,
    "canceled": 15,
    "catchAll": 12,
    "deferred": 5,
    "delivered": 280,
    "draft": 20,
    "dropped": 3,
    "errorOnSent": 5,
    "followUp": 50,
    "followUpCanceled": 10,
    "followUpDraft": 10,
    "invalid": 8,
    "pending": 100,
    "replied": 50,
    "scheduled": 500,
    "sent": 300,
    "spamReport": 2,
    "total": 1000,
    "waitingForReschedule": 5
  },
  "emoji": "🚀",
  "flow": "multiple_leads_scheduled",
  "id": 123,
  "launchAt": "2024-01-15T09:00:00Z",
  "minimumHealth": {
    "accounts": [
      {
        "address": "john@example.com",
        "healthScore": 72,
        "heldBack": true,
        "reason": "Health score 72% is below this campaign's minimum of 80%.",
        "senderEmailId": 123
      }
    ],
    "heldBackCount": 1,
    "message": "1 of 3 email accounts is below this campaign's minimum health score of 80% and sends nothing in it until its score is back up.",
    "minimumHealthScore": 80
  },
  "name": "Q1 Outreach Campaign",
  "schedule": {
    "cronSchedule": "0 9 * * 1-5",
    "daysSchedule": "1,2,3,4,5",
    "endSchedule": "17:00",
    "everySchedule": 30,
    "maximumTimeBetweenEmails": 15,
    "minimumTimeBetweenEmails": 5,
    "startSchedule": "09:00"
  },
  "sendAt": "2024-01-15T10:00:00Z",
  "settings": {
    "dailyLimit": 200,
    "ignoreOutOfOfficeReplies": true,
    "isEnabledCatchallValidated": true,
    "isEnabledIgnoreHardBouncedLeads": true,
    "isEnabledIgnoreLeadsWhoAlreadyResponded": true,
    "isEnabledLlm": true,
    "isEnabledStopFollowUpsAcrossCampaigns": true,
    "isEnabledStopFollowUpsOnReply": true,
    "maximumSendingLimitPerSenderEmail": 50,
    "maximumSendingLimitPerSenderEmailVariation": 10,
    "minimumHealthScore": 80
  },
  "status": "running",
  "timezone": "America/New_York",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Changes

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