Controller: CampaignController

Method: campaigns

Authentication: 1

Authorization: data, search, navigator, statistics

Parameters: archived

Description: This method is employed to provide a JSON-formatted list of all campaigns.

Controller: CampaignController

Method: fetchCampaignsAll

Authentication: 1

Authorization: data, search, navigator, statistics

Parameters: archived, pageIndex, pageSize, filter, filterTag, country

Description: This method filters campaigns based on a specific tag.

Controller: CampaignController

Method: getAllActiveCampaign

Authentication: 1

Authorization: data, search, navigator, statistics

Parameters: country

Description: This method is used to retrieve a list of all active campaign by country.

Controller: CampaignController

Method: getAllTags

Authentication: 1

Authorization: data, search, navigator, statistics

Parameters: country, archived

Description: This method fetches all tags across all campaigns.

Controller: CampaignController

Method: duplicateCampaign

Authentication: 1

Authorization:

Parameters:

Description: This method is utilized to create a duplicate campaign.

Controller: CampaignController

Method: duplicateDelivery

Authentication: 1

Authorization:

Parameters:

Description: This method is employed to generate a duplicate delivery module.

Controller: CampaignController

Method: getDeliveryByCampaignId

Authentication: 1

Authorization:

Parameters: cid

Description: This method is used to retrieve a list of delivery modules associated with a specific campaign.

Controller: CampaignController

Method: getCampaignInfo

Authentication: 1

Authorization: self-service

Parameters: id

Description: This method is employed to retrieve a comprehensive description of a campaign, including information about the publisher, creatives, campaign details, and more.

Controller: CampaignController

Method: addCampaignNew

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to initiate the creation of a new campaign.

Controller: CampaignController

Method: updateCampaignNew

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to modify the campaign details.

Controller: CampaignController

Method: saveCampaignCreatives

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is utilized to store attachments for a campaign.

Controller: CampaignController

Method: getCampaignCreatives

Authentication: 1

Authorization: self-service

Parameters: cid, pid, country

Description: This method is employed to retrieve attachments associated with a campaign.

Controller: CampaignController

Method: deleteCampaignCreatives

Authentication: 1

Authorization: self-service

Parameters: cid, pid, index

Description: This method is utilized to remove attachments from a campaign.

Controller: CampaignController

Method: getCollection

Authentication: 1

Authorization: self-service

Parameters: country, campaignId, clientId

Description: This method is used to retrieve all collection fields and the collection fields specific to a particular campaign.

Controller: CampaignController

Method: addCollections

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to store collection fields for a specific campaign.

Controller: CampaignController

Method: collectionChangeOrder

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to preserve the order of collection fields for a particular campaign.

Controller: CampaignController

Method: deleteCollection

Authentication: 1

Authorization: self-service

Parameters: id

Description: This method is employed to delete or remove collection fields from a specific campaign.

Controller: CampaignController

Method: updateBasicValidationFilter

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to apply a basic default validation to a collection field in a campaign.

Controller: CampaignController

Method: addAdvancedValidation

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to include an advanced validation module in a specific campaign.

Controller: CampaignController

Method: advancedValidationUpdate

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to update all advanced validation modules and its parameters associated with a specific campaign.

Controller: CampaignController

Method: advancedValidationDelete

Authentication: 1

Authorization: self-service

Parameters: id, campaignId, validation_name

Description: This method is utilized to delete advanced validation modules associated with a particular campaign.

Controller: CampaignController

Method: getAdvanceValidationModuleList

Authentication: 1

Authorization: self-service

Parameters: country, clientId, campaignId

Description: This method is employed to retrieve a list of advanced validation modules categorized as Validation, Enrichment, or Action.

Controller: CampaignController

Method: userSelectedAdvanceValidationModule

Authentication: 1

Authorization: self-service

Parameters: country, clientId, campaignId

Description: This method is utilized to retrieve a list of advanced validation modules added by a user to a particular campaign.

Controller: CampaignController

Method: checkParams

Authentication: 1

Authorization: self-service

Parameters: country, campaignId

Description: This method is used to verify whether all the mandatory parameters for user-added validation modules have been provided. If any of the essential parameters are empty, an error symbol will be displayed.

Controller: CampaignController

Method: getDeliveryModules

Authentication: 1

Authorization: self-service

Parameters: country, clientId, campaign_id, client_config

Description: This method is used to retrieve a list of all delivery modules, including the user-added delivery modules, for a specific campaign.

Controller: CampaignController

Method: addDeliveryModule

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to add a delivery module and its associated parameters to a campaign.

Controller: CampaignController

Method: updateDeliveryModule

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to update a delivery module and its parameters in a campaign.

Controller: CampaignController

Method: deliveryDelete

Authentication: 1

Authorization: self-service

Parameters: id, campaignId, moduleName

Description: This method is employed to remove a delivery module from a campaign.

Controller: CampaignController

Method: deliveryModuleCheckParams

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to verify whether all the mandatory parameters for user-added delivery modules have been provided. If any of the essential parameters are empty, an error symbol will be displayed.

Controller: CampaignController

Method: updateDistribution

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is utilized to update the distribution level for each user-added delivery module within a campaign.

Controller: CampaignController

Method: getFieldsDelivery

Authentication: 1

Authorization: self-service

Parameters: deliveryId, country, campaignId, clientId

Description: This method is used to retrieve the list of all collected fields that will be delivered by a delivery module in a campaign.

Controller: CampaignController

Method: getSqlCommands

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to retrieve the list of all SQL filters that can be applied to any collection field within a delivery module of a campaign.

Controller: CampaignController

Method: addFields

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is specifically used to update the sort order, delivery filter name, and where condition for a collected field intended for delivery in a delivery module within a campaign.

Controller: CampaignController

Method: deleteField

Authentication: 1

Authorization: self-service

Parameters: id, field, campaignName, importFielddeliveryId, campaignId

Description: This method is used to delete a collection field that was intended for delivery in a delivery module of a campaign.

Controller: CampaignController

Method: sortFieldOrder

Authentication: 1

Authorization:

Parameters:

Description: This method is employed to modify the order of collection fields to be delivered within a delivery module of a campaign.

Controller: CampaignController

Method: addFieldRow

Authentication: 1

Authorization:

Parameters:

Description: This method is used to include a collection field that can be delivered within a delivery module of a campaign.

Controller: CampaignController

Method: updateFieldRow

Authentication: 1

Authorization:

Parameters:

Description: This method is specifically used to update the SQL filter for a collected field intended for delivery in a campaign.

Controller: CampaignController

Method: addSchedule

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to schedule the execution of a specific delivery module within a campaign.

Controller: CampaignController

Method: deleteSchedule

Authentication: 1

Authorization: self-service

Parameters: id, delete_schedule, campaignName, deliveryModuleName

Description: This method is used to remove a schedule for a delivery module within a campaign.

Controller: CampaignController

Method: getCampaignSummary

Authentication: 1

Authorization: self-service

Parameters: clientId, clientConfig, campaignId, country

Description: This method is employed to retrieve a comprehensive summary of a campaign, encompassing information about collected fields, validation modules, delivery modules, feedback modules, and flow modules. This summary is intended to be presented to the user for review before finalizing the setup.

Controller: CampaignController

Method: getFieldsForValidation

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to verify whether the removal of a collection field, if it is being used in any validation module. If it is in use, the system will prompt the user to remove the associated validation module before deleting the collection field.

Controller: CampaignController

Method: updateCollectionField

Authentication: 1

Authorization:

Parameters:

Description: This method is employed to update the sample data and descriptions for all collection fields of the "field" type in a campaign.

Controller: CampaignController

Method: getAssignedDelivery

Authentication: 1

Authorization: self-service

Parameters: campaignId, period, clientId, country

Description: This method is used to retrieve all assigned deliveries for a campaign, including the delivery history of leads (whether they were delivered or not) for durations of 7, 30, and 365 days.

Controller: CampaignController

Method: moveAssignedDelivery

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is employed to transfer all non-delivered leads from one delivery module to another within a campaign.

Controller: CampaignController

Method: resetFieldRow

Authentication: 1

Authorization:

Parameters:

Description: This method is specifically used to delete the SQL filter that has already been added to a collected field intended for delivery in a campaign.

Controller: CampaignController

Method: testConnection

Authentication: 1

Authorization: self-service

Parameters:

Description:

Controller: CampaignController

Method: getReportingModuleList

Authentication: 1

Authorization: self-service

Parameters: country, clientId, campaignId

Description: This method is employed to retrieve a list of reporting modules that can be added to a campaign.

Controller: CampaignController

Method: userSelectedReportingModule

Authentication: 1

Authorization: self-service

Parameters: country, clientId, campaignId

Description: This method is utilized to retrieve a list of reporting modules added by a user to a particular campaign.

Controller: CampaignController

Method: addReporting

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to include a reporting module in a specific campaign.

Controller: CampaignController

Method: reportingDelete

Authentication: 1

Authorization: self-service

Parameters: id, reporting_name

Description: This method is employed to remove a reporting module from a specific campaign.

Controller: CampaignController

Method: reportingUpdate

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to update the reporting module and its associated parameters within a specific campaign.

Controller: CampaignController

Method: reportingCheckParams

Authentication: 1

Authorization: self-service

Parameters: country, campaignId

Description: This method is used to verify whether all the mandatory parameters for user-added reporting modules have been provided. If any of the essential parameters are empty, an error symbol will be displayed.

Controller: CampaignController

Method: checkReporting

Authentication: 1

Authorization: self-service

Parameters: agency

Description: This method is used to request user confirmation for adding the selected reporting module to another campaign with the same destination.

Controller: CampaignController

Method: deleteReporting

Authentication: 1

Authorization: self-service

Parameters: agency, country

Description: This method is used to delete a reporting in a specific campaign.

Controller: CampaignController

Method: getFlowModules

Authentication: 1

Authorization: self-service

Parameters: country, clientId, campaign_id, client_config

Description: This method is employed to retrieve a list of flow modules that can be added to a campaign.

Controller: CampaignController

Method: addFlowModule

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to include a flow module in a specific campaign.

Controller: CampaignController

Method: flowDelete

Authentication: 1

Authorization: self-service

Parameters: id, campaignId, moduleName

Description: This method is used to delete a flow module in a specific campaign.

Controller: CampaignController

Method: updateFlowModule

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to update the flow module and its associated parameters within a specific campaign.

Controller: CampaignController

Method: flowModuleCheckParams

Authentication: 1

Authorization: self-service

Parameters:

Description: This method is used to verify whether all the mandatory parameters for user-added flow modules have been provided. If any of the essential parameters are empty, an error symbol will be displayed.

Controller: CampaignController

Method: getPricesList

Authentication: 1

Authorization: navigator-prices

Parameters: filter, orderBy, sortDirection, pageIndex, pageSize, country, id

Description: This method is used to obtain the list of prices associated with a campaign.

Controller: CampaignController

Method: addPinCampaign

Authentication: 1

Authorization:

Parameters:

Description: This method is used to mark a particular campaign as a favorite, ensuring it is displayed at the top of the campaign listing.

Controller: CampaignController

Method: deletePinCampaign

Authentication: 1

Authorization:

Parameters: cid

Description: This method is used to remove a particular campaign from the list of favorites, returning it to its default position in the campaign listing.