GET/v1.1/bulk
Retrieve results from a previously submitted bulk URL processing job.
Endpoint
https://api.sharedcount.com/v1.1/bulk
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| bulk_id | string | The bulk_id provided by the POST/v1.1/bulk call. | true |
| apikey | string | Your API Key. | true |
Code Examples
Curl
Node.js
Python
Php
# Check status and get results
curl 'https://api.sharedcount.com/v1.1/bulk?apikey=YOUR_API_KEY&bulk_id=BULK_ID'
# Force return of partial results
curl 'https://api.sharedcount.com/v1.1/bulk?apikey=YOUR_API_KEY&bulk_id=BULK_ID&force=1'
npm i sharedcount-sdk
const SharedCountApi = require('sharedcount-sdk');
let sharedCountApiInstance = new SharedCountApi('YOUR_API_KEY');
// Get bulk_id from bulk post response, then use bulkGet to get results
var bulkId = bulkPostResponse.data.bulk_id;
var bulkResponse = sharedCountApiInstance.bulkGet(bulkId);
// Check if job is complete
if (bulkResponse._meta.completed) {
console.log('All URLs processed:', bulkResponse.data);
} else {
console.log('Progress:', bulkResponse._meta.urls_completed + '/' + bulkResponse._meta.urls_queued);
}
pip install sharedcountsdk
from sharedcountsdk import SharedCountApi
sharedCountApiInstance = SharedCountApi('YOUR_API_KEY')
# Get bulk_id from bulk post response, then use bulkGet to get result
bulkId = bulkPostResponse['bulk_id']
bulkResponse = sharedCountApiInstance.bulkGet(bulkId)
# Check if job is complete
if bulkResponse['_meta']['completed']:
print('All URLs processed:', bulkResponse['data'])
else:
print(f"Progress: {bulkResponse['_meta']['urls_completed']}/{bulkResponse['_meta']['urls_queued']}")
composer require sharedcount/sharedcount-sdk
require __DIR__ . '/vendor/sharedcount/sharedcount-sdk/lib/api.php';
$sharedcountApiInstance = new SharedcountApi('YOUR_API_KEY');
// Get bulk_id from bulk post response, then use bulkGet to get result
$bulkId = $bulkPostResponse['bulk_id'];
$bulkResponse = $sharedcountApiInstance->bulkGet($bulkId);
// Check if job is complete
if ($bulkResponse['_meta']['completed']) {
echo 'All URLs processed: ' . json_encode($bulkResponse['data']);
} else {
echo 'Progress: ' . $bulkResponse['_meta']['urls_completed'] . '/' . $bulkResponse['_meta']['urls_queued'];
}
Result Format
Success
Incomplete
{
"data": {
"http://google.com/": {
"Pinterest": 1436815,
"Facebook": {
"total_count": 4629449,
"comment_count": 225136,
"reaction_count": 1258082,
"share_count": 3145819,
"comment_plugin_count": 412
}
},
"http://stackoverflow.com/": {
"Pinterest": 1234,
"Facebook": {
"total_count": 5678,
"comment_count": 90,
"reaction_count": 1234,
"share_count": 3456,
"comment_plugin_count": 78
}
}
},
"_meta": {
"urls_completed": 100,
"bulk_id": "a4f8f0fd436995987dbef98bbff9accc61282c63",
"completed": true,
"urls_queued": 100
}
}{
"data": [],
"_meta": {
"urls_completed": 90,
"bulk_id": "a4f8f0fd436995987dbef98bbff9accc61282c63",
"completed": false,
"urls_queued": 100
}
}
