campaigns

Campaign List

List your organization's Campaigns

get/campaigns/

Request

  • Base URL: https://api.mainstay.com
  • URL: https://api.mainstay.com/campaigns/
  • Auth: API key in header Authorization

Query parameters

sincestring

Return all campaigns since this date. <br />Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

beforestring

Return all campaigns before this date.<br />Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

scriptstring

Return all campaigns with scripts matching this AdmitHub campaign script id. <br />Can be found in the URL when viewing a campaign script in Mascot<br />https://mascot.admithub.com/campaign-scripts/campaign-script-id

statusstring

Return all campaigns that match this status.<br />Possible values: <code>scheduled</code>, <code>started</code>, <code>completed</code>

schedulerstring

Return all campaigns scheduled by a Mascot admin with this AdmitHub user ID.

show_hiddenstring

If <u>true</u>, show campaigns hidden from the Mascot calendar. Otherwise, these campaigns are excluded from results.<ul><li>Possible true values: True, true, 1</li><li>Possible false values: False, false, 0</li><li>Default value: False</li><ul>

show_teststring

If <u>true</u>, show campaign tests. Otherwise, these campaigns are excluded from results.<ul><li>Possible true values: True, true, 1</li><li>Possible false values: False, false, 0</li><li>Default value: False</li><ul>

crm_idstring

Return all campaigns for which a contact with the provided CRM ID was a recipient. <br />By default, only complete, non-test, non-hidden campaigns will be returned.

admithub_contact_idstring

Return all campaigns for which a contact with the provided AdmitHub ID was a recipient. <br />By default, only complete, non-test, non-hidden campaigns will be returned.

pageinteger

A page number within the paginated result set.

Response

OK

idstring

AdmitHub campaign ID<br />Can be found in the URL when viewing a campaign in Mascot<br />https://admithub.mascot.com/campaigns/campaign-id

namestring

Name of the campaign

createdstring date-time

Time of campaign creation

timestring date-time

Time campaign is scheduled for (UTC)

status'completed' | 'started' | 'scheduled'
scheduler_idstring

AdmitHub user ID of campaign creator

typestring

<code>"interactive"</code> if campaign has branches, <code>"nudge"</code> if not

import_labelsstring

Labels of the imports or partial imports used

audience_idstring

ID of the Audience used

audience_namestring nullable

Name of the Audience used

script_idstring

AdmitHub campaign script ID<br />Can be found in the URL when viewing a campaign script in Mascot<br />https://admithub.mascot.com/dialogs/campaign-script-id

script_namestring

Human-readable name of campaign script

script_createdstring date-time

Date of the Script's creation

total_intended_recipientsinteger

Count of the set of all Contacts that were targeted at the outset of this campaign

intended_recipientsinteger[]

Mainstay IDs of the set of all Contacts that were targeted at the outset of this campaign

total_prior_optoutsinteger

Number of contacts targeted in the campaign who were opted out when campaign was sent.<br />These contacts did not receive the campaign.

prior_opt_out_usersstring[] nullable

Mainstay IDs of contacts targeted in the campaign who were opted out when campaign was sent.<br />These contacts did not receive the campaign.

total_prior_pausesinteger

Number of contacts targeted in the campaign who were paused when campaign was sent.<br />These contacts did not receive the campaign.

prior_pause_usersstring[] nullable

Mainstay IDs of contacts targeted in the campaign who were paused when campaign was sent.<br />These contacts did not receive the campaign.

total_prior_invalid_phone_statusinteger

Number of contacts targeted in the campaign who had an invalid phone number when campaign was sent.<br />These contacts did not receive the campaign.

prior_invalid_phone_status_usersstring[] nullable

Mainstay IDs of contacts targeted in the campaign who had an invalid phone number when campaign was sent.<br />These contacts did not receive the campaign.

total_delivery_failuresinteger

Number of delivery failures - contacts who for any reason did not receive one or more messages from the campaign<br />E.g. - contact's phone number in the AdmitHub database is a land-line<br />E.g. - contact's cellular carrier blocked delivery of a message

delivery_failure_usersstring[] nullable

Mainstay IDs of contacts targeted in the campaign for whom there was an error in delivering the campaign

total_active_recipientsinteger

Number of contacts targeted in the campaign who received at least one message and responded at least once to this campaign.

active_recipientsstring[] nullable

Mainstay IDs of contacts targeted in the campaign who received at least one message and responded at least once to this campaign.

total_passive_recipientsinteger

Number of contacts targeted in the campaign who received at least one message but have not responded to this campaign.

passive_recipientsstring[] nullable

Mainstay IDs of contacts targeted in the campaign who received at least one message but have not responded to this campaign.

total_resulting_optoutsinteger

Number of contacts targeted in the campaign who opted out in reaction to any messages received during the campaign

resulting_optout_usersstring[] nullable

Mainstay IDs of contacts targeted in the campaign who opted out in reaction to any messages received during the campaign

total_resulting_pausesinteger

Number of contacts targeted in the campaign who paused in reaction to any messages received during the campaign

resulting_pause_usersstring[] nullable

Mainstay IDs of contacts targeted in the campaign who paused in reaction to any messages received during the campaign

total_optoutsinteger

Number of all contacts targeted in the campaign who were opted out or paused when campaign was sent.<br />These contacts did not receive the campaign.

total_recipientsinteger

Number of messaged contacts

usersstring[] nullable

Mainstay IDs of contacts targeted by campaign

total_responsesinteger

Number of contacts who responded to the campaign

Changes

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