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

Bulk Collect (Bulk API) is an extension of Base Employee API and includes five POST and two GET endpoints.

Collect employee data in bulk using an employee ID list, search filters, or Elasticsearch DSL schema that is already used in the Base Employee API.

Request type	Endpoint
POST	/v2/data_requests/employee_base/ids
POST	/v2/data_requests/employee_base/es_dsl
POST	/v2/data_requests/employee_base/filter
POST	/v2/data_requests/employee_base/shorthand_names
POST	/v2/data_requests/employee_base/urls
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/employee_base/filter and /v2/data_requests/employee_base/es_dsl endpoints.

Request example to retrieve five records

Search filters example

Search filters

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/filter' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{optional_webhook_url}",
  "limit": 5,
"filters": {
      "title": "CSO",
      "location": "United States",
      "industry": "Information Technology"
      }
}'

Elasticsearch DSL example

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{optional_webhook_url}",
  "limit": 5,
"es_dsl_query": {
   "query":{
      "bool":{
         "must":[
            {
               "match":{
                  "title":{
                     "query":"Developer",
                     "operator":"and"
                  }
               }
            },
            {
               "match":{
                  "location":{
                     "query":"United States",
                     "operator":"and"
                  }
               }
            },
            {
               "nested":{
                  "path":"member_experience_collection",
                  "query":{
                     "bool":{
                        "must":[
                           {
                              "query_string":{
                                 "query":"IT Company",
                                 "default_field":"member_experience_collection.company_name",
                                 "default_operator":"and"
                              }
                           }
                        ]
                     }
                  }
               }
            }
         ]
      }
   }
}
}'

Credits

Your credits for Base Employee 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 credits in Bulk Collect usage in the main Base Employee API topic.

Webhooks

POST endpoints allow you to add webhooks and get notified when your data request is ready.

Keep in mind that webhook_url is optional.

Search filter template

Search filter template

{
  "webhook_url": "{optional_webhook_url}",
  "filters": {}
}

Elasticsearch DSL template

Elasticsearch DSL template

{
  "webhook_url": "{optional_webhook_url}",
  "es_dsl_query": {}
}

IDs template

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/ids' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'webhook_url={optional_webhook_url}' \
  -F 'ids={list of ids}'