campaignpluginconfiguration_

Campaign Plugin Configuration

A campaign is the 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 is associated with the portal.
You can modify the splash page of the portal through the Mojo Canvas app. Click Manage Campaigns on the Campaigns tab of the portal page to access the Mojo Canvas app. The app enables you to create campaigns and add guest authentication and engaging content to the campaigns.

JSON Table

Parameter Data Type Description
success boolean Whether the API call was successful or not.
message String A message indicating the API success or failure.
data application/json A JSON object for the response data.
data/fbConfig application/json This displays all the details of the plugin configuration that is specified.
data/fbConfig/pid int This is the portal id on which the application is made.
data/fbConfig/app_id int This is the id specifies the campaign plugin. Could be a large number.
data/fbConfig/app_secret int This is the authorized key value for the app that is used.
data/fbConfig/like_page String This specifies the URL of the plugin name that is used, this button is used to like the particular page on the plugin.
data/fbConfig/like_page_display int This generates the data for all the APIs connected with all the duration details.
data/fbConfig/date_created Dateate This is the date on which this campaign plug-in was created.
data/fbConfig/session_timeout date This is the maximum time till which a session runs. It may vary as per the input.
data/fbConfig/blackout_time date This specifies the time when the screen may run out.
data/fbConfig/date_modified date This is the date on which the plugin information might have been modified, if done.
data/fbConfig/redirect_landing_url String This specifies the URL onto which the plugin gets redirected in case of any network failure or server issue.
data/fbConfig/bandwidth_upload_limit int This specifies the maximum limit of the bandwidth that can be uploaded for the plugin.
data/fbConfig/bandiwdth_download_limit int This specifies the maximum download limit for the plugin.
data/fbConfig/redirect_endpoint_id int There is a specific id for the URL onto which the plugin is redirected. This id is specified for the particular sites.
data/fbConfig/redirect_camapign_id int There is a specific id for the URL onto which the plugin is redirected. This id is specified for the particular sites.
data/fbConfig/redirect_type String This specifies the type of redirect we want it to go to. It can vary from redirect landing URL or redirect campaign URL.
data/fbConfig/selected_categories application/json This specifies the categories in the plugin that we can select by ourselves.
data/fbConfig/selected_categories/email String This is the mail id of the user.
data/fbConfig/selected_categories/user_birthday date This is the birthday of the user.
data/fbConfig/selected_categories/user_likes String This specifies the likes that user has liked in the name of plugin that is mentioned.
data/fbConfig/selected_categories/user_location String This specifies the particular location of the user that is used.
data/fbConfig/all_categories application/json This generates all the categories that the plugin contains.
data/fbConfig/all_categories/email String This is the user email id.
data/fbConfig/all_categories/user_birthday date This specifies the birthdate of the user.
data/fbConfig/all_categories/user_likes int This specifies the likes that user has aforementioned in the particular plugin.
data/fbConfig/all_categories/user_location String This is the location of the user that might have been shared.
data/fbConfig/campaign int This is the campaign value that might have been shared with the plugin name. Its value can vary from being null.

Copy Sample JSON
Sample JSON 
{
    "success": true,
    "message": "Record Found",
    "data": {
        "totalCount": 1,
        "fbConfig": {
            "pid": 1,
            "app_id": "1524614121112909",
            "app_secret": "1abaf796d44bb28753e575ce53c0b971",
            "like_page": "https://www.facebook.com/watchguardtechnologies",
            "like_page_display": 1,
            "date_created": "2017-09-11 05:37:20.992108",
            "session_timeout": null,
            "blackout_time": null,
            "date_modified": "2018-02-15 07:14:45.792814",
            "redirect_landing_url": "http://www.google.com",
            "bandwidth_upload_limit": null,
            "bandwidth_download_limit": null,
            "redirect_endpoint_id": null,
            "redirect_campaign_id": null,
            "redirect_type": "redirect_landing_url",
            "selected_categories": [
                "email",
                "user_birthday",
                "user_likes",
                "user_location"
            ],
            "all_categories": {
                "email": "User EmailID",
                "user_birthday": "Users Birthday",
                "user_likes": "User Likes",
                "user_location": "User Location"
            },
            "campaign": null
        }
    }
}
API Calls
Get

/V1.14/portals/{portal_id}/{plugin_name}/config

Put

/V1.14/portals/{portal_id}/{plugin_name}/config

Get Campaign Plugin Configuration

Description This API fetches the details of the campaign plugin configuration accounts.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Syntax
GET <Base_URL>/portals/{pid}/{plugin_name}/config

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • uid

    It is the unique ID of the guest user account in the Guestbook plug-in that is being updated.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/facebook/config
Request Body This API call does not require any request body parameters.
Response Body The API returns the guest user account and profile details in the response body.
The response is in the application/json format.

Update Campaign Plugin Configuration

Description This API fetches the guest user account and profile details of all the guest users.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal from which the guest user accounts for the Guestbook plug-in are fetched.
Syntax
PUT <Base_URL>/portals/{pid}/{plugin_name}/config

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • plugin_name

    It is the name of the plugin that we are using like twitter, Facebook, Gplus, LinkedIn or WeChat.
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/facebook/config
Request Body This API call specifies the details that are needed to be updated. This is the request body:

{
"redirect_landing_url": "www.google.com"
}
Response Body The API returns the details of the updated campaign plugin.
The response is in the application/json format.