Definition
The getSocialVisibility API Command will return the social data regarding the links in the campaign.
Cost
Using this command consumes 1 credit for each data point extracted.
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. |
| siteId | The ID Number of the site you will import links to. |
| includeNoise | (optional) Filters the noise. Default value = no |
Input URL Example
http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=getSocialVisibility&campaignId=7&siteId=39&includeNoise=yes&limit=10
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 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
{ "api": "cognitiveSEO API", "data": { "status": "success", "data": { "1": { "url": "http:\/\/www.cognitiveseo.com\/blog1", "fbLikes": "0", "fbShares": "0", "fbComments": "0", "fbTotal": "0", "twitter": "0", "googlePlus": "0", "excludeUrl": "no", "cognitiveseoDate": "2015-01-19" }, "2": { "url": "http:\/\/www.cognitiveseo.com\/*blog2", "fbLikes": "0", "fbShares": "0", "fbComments": "0", "fbTotal": "0", "twitter": "0", "googlePlus": "0", "excludeUrl": "no", "cognitiveseoDate": "2015-01-16" }, "3": { "url": "http:\/\/www.cognitiveseo.com\/blog3", "fbLikes": "0", "fbShares": "0", "fbComments": "0", "fbTotal": "0", "twitter": "0", "googlePlus": "0", "excludeUrl": "no", "cognitiveseoDate": "2015-01-19" } }, "credits": 3 }, "time": 1.614 } |
Output Details
| status | The status of the command (success or error). |
| url | The URL for the link. |
| fbLikes | Total number of Facebook likes. |
| fbShares | Total number of Facebook shares. |
| fbComments | Total number of Facebook comments. |
| fbTotal | Total Facebook activity. |
| Total number of Twitter shares. | |
| googlePlus | Total number of googlePlus shares. |
| excludeUrl | If the link has been excluded from the application. (Values: yes or no) |
| cognitiveseoDate | The date when the link was inserted into cognitiveSeo. |
| credits | The credit cost of the command. |
| time | The time it took to process the command. |