Definition
The getCampaignHistory API Command extracts a history of actions performed for the selected campaign. To perform this command the campaign must have at least two recrawls and be a recurring 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 existing campaign. |
| siteId | The ID number of the website. |
| dateFrom | The first date from which to begin extraction. *if no value inserted, the default is the first date found in the database. |
| dateTo | The last date from which to extract. |
| date | Extracting links from a fixed date. |
| historyBy | Takes the following values: linkvelocity; analysedlinks; newlost; unnatural; livelost; nofollowdofollow; textimageredirect; webpagetype; linkpositioning; webpagecategory. |
Input URL Example
http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=getCampaignHistory&campaignId=3&siteId=3&dateFrom=2015-01-01&historyBy=unnatural
Output Example
Running this command will result in the following JSON output:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
{ "api": "cognitiveSEO API", "data": { "status": "success", "data": { "2015-01-07": { "unnatural": "73", "suspect": "8", "ok": "41" }, "2015-01-14": { "unnatural": "76", "suspect": "8", "ok": "41" } }, "credits": 2 }, "time": 0.562 } |
Output Details
| status | The status of the command (success or error). |
| data | The date in which the analysis was done. |
| unnatural | The number of unnatural links. |
| suspect | The number of suspect links. |
| ok | The number of ok links. |
| credits | The credit cost of the command. |
| time | The time it took for the command to take place. |