Skip to main content

Campaigns

The Campaigns API allows you to find specific campaigns and retrieve lists of campaigns from your account.

Find Campaign

QUERYcampaign

Retrieves details for a specific campaign by ID, name or platformId.

Arguments

ParameterTypeDescription
criteriaCampaignLookupInputRequired Criteria for finding a campaign

CampaignLookupInput

FieldTypeDescription
idIDOptional ID of the campaign to find
nameStringOptional Name of the campaign to find
platformIdStringOptional Platform ID of the campaign to find

Example Query

query {
viewer {
campaign(criteria: {
name: "Q1 Marketing Campaign"
}) {
id
name
description
status
sendRate
emailSendingAmount
platform
platformCampaignId
brand {
name
}
createdAt
updatedAt
domain {
id
name
}
}
}
}

Response

{
"data": {
"viewer": {
"campaign": {
"id": "Q2FtcGFpZ246MTA=",
"name": "Q1 Marketing Campaign",
"description": "First quarter marketing outreach",
"status": "active",
"sendRate": "High Speed Ramp Up",
"emailSendingAmount": 500,
"platform": "instantly",
"platformCampaignId": "camp_12345",
"brand": {
"name": "Acme Inc."
},
"createdAt": "2024-01-10T08:15:30Z",
"updatedAt": "2024-01-15T14:22:45Z",
"domain": {
"id": "RG9tYWluOjIz",
"name": "marketing.acme.example.com"
}
}
}
}
}

List Campaigns

QUERYcampaigns

Retrieves a paginated and filterable list of campaigns. Requires admin access.

Arguments

ParameterTypeDescription
filterCampaignListFilterInputRequired Filter and pagination options

CampaignListFilterInput

FieldTypeDescription
platformStringOptional Filter campaigns by platform type
filterStringOptional Search term to filter campaigns by name
pageIntOptional Page number for pagination (default: 1)
limitIntOptional Maximum number of campaigns to return per page (default: 10)

Example Query

query {
viewer {
campaigns(filter: {
platform: "instantly",
filter: "marketing",
page: 1,
limit: 10
}) {
items {
id
name
description
status
platform
brand {
name
}
createdAt
}
total
page
limit
pages
}
}
}

Response

{
"data": {
"viewer": {
"campaigns": {
"items": [
{
"id": "Q2FtcGFpZ246MTA=",
"name": "Q1 Marketing Campaign",
"description": "First quarter marketing outreach",
"status": "active",
"platform": "instantly",
"brand": {
"name": "Acme Inc."
},
"createdAt": "2024-01-10T08:15:30Z"
},
{
"id": "Q2FtcGFpZ246MTI=",
"name": "Product Marketing Initiative",
"description": "New product launch marketing",
"status": "draft",
"platform": "instantly",
"brand": {
"name": "Acme Partners"
},
"createdAt": "2024-01-25T11:30:45Z"
}
],
"total": 2,
"page": 1,
"limit": 10,
"pages": 1
}
}
}
}

Campaign Fields

The Campaign object contains the following fields:

FieldTypeDescription
idIDUnique identifier for the campaign
nameStringName of the campaign
descriptionStringDescription of the campaign
statusCampaignStatusEnumCurrent status of the campaign
sendRateCampaignSendRateEnumSend rate configuration
emailSendingAmountIntNumber of emails to send
inCurrentSendRateSinceDateTimeDate since current send rate was set
sendRateStack[SendRateStack]History of send rate changes
sendingModeCampaignSendingModeEnumMode of sending (Manual, Auto, Instantly)
platformStringPlatform used for the campaign
platformCampaignIdStringID of the campaign on the platform
brandBrandBrand associated with the campaign
userUserUser who created the campaign
createdAtStringCreation date of the campaign
updatedAtStringLast update date of the campaign
domainDomainDomain used for sending campaign emails
dealSettingCampaignDealSettingDeal settings for the campaign
sentInRolling24hrsIntNumber of emails sent in the last 24 hours
stage1SentInRolling24hrsIntNumber of stage 1 emails sent in the last 24 hours
stage2SentInRolling24hrsIntNumber of stage 2 emails sent in the last 24 hours
campaignSnapshotCampaignSnapshotCurrent snapshot of campaign metrics
warmupLimitStack[WarmupLimitStack]History of warmup limit changes
dailyLimitStack[DailyLimitStack]History of daily limit changes
lastSpamTestAtDateTimeDate of the last spam test

Campaign Status

A campaign can have one of the following status values:

StatusDescription
draftThe campaign has been created but not yet activated
activeThe campaign is currently active and sending emails
pausedThe campaign has been temporarily paused
completedThe campaign has completed its scheduled sends
accounts_unhealthyThe campaign is paused because associated accounts are unhealthy
bounce_protectThe campaign is paused due to bounce protection

Working with Campaigns

Access Control

Access to campaign data is controlled by user permissions:

  • Global administrators can access any campaign
  • Organisation administrators can access campaigns within their organisation's brands
  • Brand administrators can access campaigns within their brand
  • Regular users may have limited or no access to campaign data

Campaign Analytics

The SixtySeconds platform provides comprehensive analytics for campaigns:

  • Email sending statistics (sent, opened, replied)
  • Page view and video view metrics
  • Meeting booking and button click tracking
  • Per-lead engagement data

Use the getCampaignStatByDate query to access detailed analytics for specific campaigns.

Campaign Warmup

To maintain good email deliverability, the platform supports campaign warmup strategies:

  • High Speed Ramp Up: Quickly ramp up sending volume over a few days
  • Slow Speed Ramp Up: Gradually increase sending volume over several weeks
  • Full Scale Sending: Send at maximum configured volume
  • Perma-Warm: Maintain a constant low-volume sending pattern
  • Idle-Paused: Temporarily pause sending