campaigns

Campaigns

With a campaign defined in Mojo Canvas, a web app that enables you to design onsite guest engagement campaigns. A campaign must be published before it can be associated with a portal in Guest Manager. To publish a campaign it must have a splash page. A published campaign can contain only one active splash page and one active landing page.
A campaign is a container for splash pages and landing pages designed using Mojo Canvas. You must associate an appropriate campaign with the portal so that the published splash page in the campaign associated with the portal.

JSON Table
Copy Sample JSON
Sample JSON
API Calls
Get

/V1.14/campaigns

Get

/V1.14/campaigns/{campaign_id}

Get

/V1.14/campaigns/{campaign_id}/splashpages

Get

/V1.14/campaigns/{campaign_id}/landingpages

Get

/V1.14/campaigns/{campaign_id}/splashpages/{splashpage_id}

Get

/V1.14/campaigns/{campaign_id}/landingpages/{landingpage_id}

Get

/V1.14/campaigns/{campaign_id}/splashpages/{splashpage_id}

Get

/V1.14/campaigns/{campaign_id}/splashpages/{splashpage_id}

Get

/V1.14/campaigns/{campaign_id}/landingpages/{landingpage_id}

Put

/V1.14/campaigns/{campaign_id}

Post

/V1.14/campaigns/{campaign_id}

Post

/V1.14/campaigns/{campaign_id}/splashpages

Post

/V1.14/campaigns/{campaign_id}/landingpages

Delete

/V1.14/campaigns/{campaign_id}

Delete

/V1.14/campaigns/{campaign_id}/splashpages/{splashpage_id}

Delete

/V1.14/campaigns/{campaign_id}/landingpages/{landingpage_id}

Get All Campaigns

Description This API call fetches all the details of all the campaigns that have been created in the Guest Manager portal.
Guest Manager users with the Administrator role or Operator role can access this API..
Syntax
GET <Base_URL>/api/v1.14/campaigns
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns
Request Body This API call does not require any request body parameters.
Response Body The API returns the campaign details. The campaign details include the id and plugin details.
The response is in the application/json format.

Get Campaign By Id

Description This API fetches the campaign details of the specified campaign measured by its id.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/12
Request Body This API call does not require any request body parameters.
Response Body The API returns the campaign details. The campaign details include the id and plugin details.
The response is in the application/json format.

Get All Splash Pages

Description This API fetches all the splash pages under the respective to the campaign id specified.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/splashpages
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/12/splashpages
Request Body This API call does not require any request body parameters.
Response Body The API returns the spalshpages for the campaign Id. Each campaign has a mandatory active splash page.
The response is in the application/json format.

Get All Landing Pages

Description This API fetches all the landing pages under the respective campaign id specified.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/landingpages
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/12/landingpages
Request Body This API call does not require any request body parameters.
Response Body The API returns the landingpages for the campaign Id.
The response is in the application/json format.

Get Splash Page Bundle Details

Description This API call fetches the splash page bundle details.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/splashpahes/{splashpage_id}
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/12/splashpages/1
Request Body This API call does not require any request body parameters.
Response Body The API returns the splashpage bundle details. The splashpage bundle returns the splashpages created under the campaign id specified.
The response is in the application/json format.

Get Landing Page Bundle Details

Description This API call fetches the landing page bundle details.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/landingpages/{landingpage_id}
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/12/landingpages/1
Request Body This API call does not require any request body parameters.
Response Body The API returns the landing page bundle details. The landing page bundle returns the landing pages created under the campaign id specified.
The response is in the application/json format.

Design Splash Page Bundle

Description This API call creates a splash page bundle which acts as a container for all the splash pages.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/splashpages/?info=1
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/splashpages/?info=1
Request Body This API call does not require any request body parameters.
Response Body The API call creates the splash page bundle for all the splashpages under one campaign for the particular campaign ID.
The response is in application/JSON format.

Design Landing Page Bundle

Description This API call creates the landing page bundle for all the landing pages for the particular campaign.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/landingpages/?info=1
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/splashpages/?info=1
Request Body This API call does not require any request body parameters.
Response Body The API call creates the landing page bundle for all the landing pages for a particular campaign.
The response is in application/JSON format.

Download Splash Page Bundle

Description This API call downloads the splash pages under the campaign ID specified.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
GET <Base_URL>/api/v1.14/campaigns/{campaign_id}/splashpages/{splashpage_id}?download=1
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/splashpages/1?download=1
Request Body This API call does not require any request body parameters.
Response Body The API call downloads the splash pages for the specific campaign ID. The downloaded file can be customised accordingly.
The response is in downloadable format.

Publish Campaign

Description This API call publishes the campaign with one active splash page.
Guest Manager users with the Administrator role or Operator role can access this API.
Syntax
PUT <Base_URL>/api/v1.14/campaigns/{campaign_id}
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1
Request Body This API call contains the name, type, status and active_splash_page_id that needs to be publsihed/updated. The sample request body will be as follows:

{
    "name": "Independence Day",
	"status": "published",
	"active_splash_page_id":2
}
Response Body The API call publishes the splashpage under the campaign id mentioned.
The response is in application/json format.

Create Campaigns

Description This call creates a campaign with the mentioned name and type.
Mojo Guest users and administrators can make the changes.
Syntax
POST <Base_URL>/api/v1.14/campaigns
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns
Request Body This API call contains the name and type of the campaign that needs to be created. The sample request body will be as follows:

{
    "name": "Independence Day",
    "type": "basic" or "pro"
}
Response Body The API call creates the campaign with the given name and type.
The response is in application/json format.

Upload Splashpage Bundle

Description This call uploads the splash page bundle that is a conatiner for all the splash pages under one campaign.
Mojo Guest users and administrators can make the changes.
Syntax
POST <Base_URL>/api/v1.14/campaigns/{campaign_id}/splashpages/?name=<name>&value=<value>
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/splashpages/?IndependenceDay&type=canvas
Request Body This API call contains the file that needs to be uploaded that conatins the splash page bundle. The sample request body will be as follows:

"file"=Zip File
Response Body The API call uploads the splash page bundle by the file that has been uploaded.
The response is in file type format.

Upload Landingpage Bundle

Description This call uploads the landing page bundle that is a conatiner for all the landing pages under one campaign.
Mojo Guest users and administrators can make the changes.
Syntax
POST <Base_URL>/api/v1.14/campaigns/{campaign_id}/landingpages
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/landingpages/?IndependenceDay&type=canvas
Request Body This API call contains the file that needs to be uploaded that conatins the landingpage bundle. The sample request body will be as follows:

"file"=Zip File
Response Body The API call uploads the landing page bundle by the file that has been uploaded.
The response is in file type format.

Delete Campaign

Description This call deletes the campaign specified by the campaign ID.
Mojo Guest users and administrators can make the changes.
Syntax
DELETE <Base_URL>/api/v1.14/campaigns/{campaign_id}
Sample code
DELETE https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1
Request Body This API call contains no request body parameters.
Response Body The API call deletes the campaign specified by the particular campaign ID.
The response is in application/JSON format.

Delete Splash Page Bundle

Description This call deletes the splash page that has been specified by its ID in the campaign.
Mojo Guest users and administrators can make the changes.
Syntax DELETE <Base_URL>/api/v1.14/campaigns/{campaign_id}/splashpages/{splashpage_id}
Sample code DELETE https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/splashpages/2
Request Body This API call contains no request body parameters.
Response Body The API call deletes the splash page specified by the particular splash page ID from the campaign ID mentioned.
The response is in application/JSON format.

Delete Landing Page Bundle

Description This call deletes the landing page that has been specified by its ID in the campaign.
Mojo Guest users and administrators can make the changes.
Syntax
DELETE <Base_URL>/api/v1.14/campaigns/{campaign_id}/landingpages/{landingpage_id}
Sample code
DELETE https://marketverticalanalytics.airtightnw.com/api/v1.14/campaigns/1/landingpages/2
Request Body This API call contains no request body parameters.
Response Body The API call deletes the landing page specified by the particular landing page ID from the campaign ID mentioned.
The response is in application/JSON format.