postKeywordCampaign

Definition

The postKeywordCampaign API Command will add keywords to a campaign. The command is processed in a queue, meaning that the result will be available after finishing creating the new campaign.

Cost

Using this command consumes 1 credit for each keyword added. *It will also consume credits from the monitored keywords pool.

Module

The command is included in the Campaign API Module and will only consume credits assigned for Campaign API Operations.

Parameters

campaignId The ID Number of the campaign.
nrKeywords Number of keywords that are going to be introduced in the campaign.
keyword(*) The keyword order you are going to insert. *number taking value from 1 to nrKeywords parameter
se The Search Engine you want to add the keyword on. Mandatory field that can have the values: Google, Bing, Yahoo.
locale The country where the tracking is made. It’s a mandatory field that should have values from here: http://support.cognitiveseo.com/knowledgebase/getsupportedcountrycodes/
mobile Allows you to decide if the tracking should be made on mobile or desktop. It’s not mandatory and can take the values “yes” or “no”. The default is “no”.
location Allows you to choose the location of the tracking. It’s not mandatory and can take the standard values given by Google (Canonical Name for Geographical Targeting). The default is Universal Ranking.

Input URL Example

http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=postKeywordCampaign&campaignId=26&nrKeywords=1&keyword1=cognitive%20seo&se=google&locale=en-us&mobile=no&location=new%20york,new%20york,united%20states  

Output Example

Running this command will result in the following JSON output:

 

Output Details

status The status of the command (success or error).
added Number of keywords added.
credits The credit cost of the command.
time The time it took to process the command.
Go Top