Bulk Collect
Overview
Discover the Bulk Collect (Bulk API) capabilities and explore potential uses for efficiently retrieving employee data in batches. Find all Bulk Collect related information in the following topic:
General information about Bulk Collect
Endpoints
POST
/v2/data_requests/job_multi_source/ids
POST
/v2/data_requests/job_multi_source/es_dsl
GET
/v2/data_requests/{data_request_id}/files
GET
/v2/data_requests/{data_request_id}/files/{file_name}
Limiting returned record count
Include the parameter "limit": int
to control the number of records returned by your queries in /v2/data_requests/job_multi_source/es_dsl
endpoint.
Request example to retrieve five records
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/data_requests/job_multi_source/es_dsl' \
-H 'accept: application/json' \
-H 'apikey: {API Key}' \
-H 'Content-Type: application/json' \
-d '{
"webhook_url": "{optional_webhook_url}",
"limit": 5,
"query": {
"match":{
"location":{
"query":"New York",
"operator":"and"
}
}
}
}'
Credits
Your credits for Multi-source Jobs API will also apply to Bulk Collect data collection requests.
Learn about the credits in Bulk Collect usage in the general Bulk Collect topic.
Rate limits
Bulk Collect endpoints have limited requests allowed per second. Learn about rate limits in Bulk Collect usage in the main Multi-source Jobs API topic.
Webhooks
POST endpoints allow you to add webhooks and get notified when your data request is ready.
{
"webhook_url": "{optional_webhook_url}",
"es_dsl_query": {}
}
Last updated
Was this helpful?