getCampaignStatus

Definition

The getCampaignStatus API Command shows the status and data of an existing campaign.

Cost

Using this command consumes 1 credit.

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 to check the status.

Input URL Example

http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=getCampaignStatus&campaignId=8

Output Example

Running this command will result in the following JSON output:

{
    "api": "cognitiveSEO API",
    "data": {
        "status": "success",
        "data": {
            "337": {
                "campaignId": "337",
                "campaignName": "gsp",
                "status": "active",
                "started": "2015-01-27 15:31:32",
                "campaignType": "recurring",
                "progress": "finished",
                "sites": {
                    "site1": {
                        "importStatus": "finished",
                        "lastImportDateStarted": "2015-01-30 09:15:32",
                        "lastImportDateFinished": "2015-01-30 09:19:19"
                    }
                }
            }
        },
        "credits": 1
    },
    "time": 0.143
}

 

Output Details

status The status of the command (success or error).
campaignId The ID number of the selected Campaign.
campaignName The name of the selected Campaign.
status Displays the current status of the campaign:
active = The campaign is up and running
inProgress = The links are being crawled
locked = it’s being updated at this time
started Displays the date when the campaign was created.
campaignType Shows the type of the campaign (recurring or onetime)
progress The progress displays whether the campaign is finished or it’s completions status (1% to 100%). Also displays when the campaign is locked.
importStatus null – no import started;
inProgress – import is currently in progress;
finished – import is finished.
lastImportDateStarted Start date of the last import.
lastImportDateFinished End date of the last import.
credits The credit cost of the command.
time The time it took for the command to take place.
Go Top