Download Results of Bulkjob

Download the result of a completed Enhance Bulkjob

Request

Authentication
`token`query	Diffbot API token, supplied as the `token` query parameter on every request. `<DIFFBOT_TOKEN>` Cache and insert token into example requests (15d expiry)

Path parameters
`bulkjobId`string required	Enhance Bulkjob ID

Query parameters
`head`integer (int32)	Return first n results (default: `0`)
`from`integer (int32)	1-based index of the first result to return (1 = first result). (default: `0`)
`size`integer (int32)	Maximum number of results to return starting from the ‘from’ position. (default: `-1`)
`onlyMatches`string	Return only records that have a match (default: `false`) One of: `truefalse`
`format`string	Export format One of: `jsonjsonlcsvxlsxlsx`
`exportspec`string	The spec defines the columns to export. This is applicable for csv, xls and xslx formats. Export spec specifies how to export the entity JSON to a csv. A simple export spec looks like `name;summary`. To specify more complex export spec, including specifying how many of a list of `industries` to return, or the ideal `employment` record, see Exporting Columnar Format and JsonPath Filtering.
`exportfile`string	File name of the export file
`exportseparator`string	Separator for multi-value fields when exporting columnar results
`exportquery`string	Prefixes the enhance query parameters to the CSV export result (default: `false`) One of: `truefalse`
`filter`string	Semi-colon separated path filter to filter response json. You can use a simple dot notation `skills.name` or a JsonPath expression such as `$.name;$.locations.country.name`. For more advanced options, see JsonPath Filtering for syntax.
`filterExclude`string	Semi-colon separated path filter to filter and exclude data from response json. You can use a simple dot notation `skills.name` or a JsonPath expression such as `$.name;$.locations.country.name`. For more advanced options, see JsonPath Filtering for syntax.
`wait`integer (int32)	Seconds to wait for bulkjob results to export. Results will continue to export in the background. To only trigger an export, use 0. (default: `120`)

Example request

bash

curl --request GET \
  --url 'https://kg.diffbot.com/kg/v3/enhance/bulk/<bulkjobId>?head=0&from=0&size=-1&onlyMatches=false&exportquery=false&wait=120&token=<DIFFBOT_TOKEN>' \
  --header 'Accept: application/json'

Response

200Result data. Depends on format (default is json lines).

201Bulkjob or result export is still executing or is stopped
`code`integer (int32)	Status code (same as the HTTP status code)
`message`string	Status message
`request_ctx`object	Request context
`↳ query`object \| object \| string	Submitted query
`↳ type`string	Diffbot entity type
`↳ name`string[]	Name of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ url`string[]	Origin or homepage URI of entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ location`string	Location of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ ip`string	IP address of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ phone`string	Phone of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ description`string	Description of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ email`string[]	Email of the entity to enhance. Parameter can be used only with type `Person`
`↳ employer`string	Employer of the entity to enhance. Parameter can be used only with type `Person`
`↳ title`string	Title of the entity to enhance. Parameter can be used only with type `Person`
`↳ school`string	School of the entity to enhance. Parameter can be used only with type `Person`
`↳ query_ctx`object	Query context. Example: submitted query parameters etc.
`bulkjobStatus`object	Bulkjob status
`↳ job_id`string	Bulkjob Id
`↳ name`string	Bulkjob name
`↳ refresh`boolean	Is Refresh enabled for this job?
`↳ search`string	Is Search enabled for this job?
`↳ message`string	Bulkjob status message
`↳ jobs_total`integer (int32)	Number of jobs in bulkjob
`↳ jobs_completed`integer (int32)	Number of jobs completed in bulkjob.
`↳ status`string	Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN}
`↳ estimate_remaining_time`integer (int64)	Estimated remaining time for bulkjob to complete (in seconds). `null` if job is completed or not started.
`↳ submit_time_ms`integer (int64)	Bulkjob submit time
`↳ start_time_ms`integer (int64)	Bulkjob start time
`↳ completed_time_ms`integer (int64)	Bulkjob completed time
`↳ total_results`integer (int32)	Total results
`↳ bulkjobId`string
`↳ totalJobs`integer (int32)
`↳ finishedJobs`integer (int32)
`↳ estimateRemainingTimeSec`integer (int64)
`↳ submitTimeMs`integer (int64)
`↳ startTimeMs`integer (int64)
`↳ completedTimeMs`integer (int64)
`↳ totalResults`integer (int32)
`↳ fileSizeBytes`integer (int64)	Size of download file in bytes
`↳ reports`object[]	Coverage reports generated for this bulkjob
`↳ reportId`string	Coverage Report ID
`↳ status`string	Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN}
`↳ format`string	Export format
`↳ spec`string	The spec defines the columns to export. This is applicable for csv, xls and xslx formats. Export spec specifies how to export the entity JSON to a csv. A simple export spec looks like `name;summary`. To specify more complex export spec, including specifying how many of a list of `industries` to return, or the ideal `employment` record, see Exporting Columnar Format and JsonPath Filtering.
`↳ exportfile`string
`↳ exportSeparator`string	Separator for multi-value fields when exporting columnar results
`↳ filter`string	Semi-colon separated path filter to filter response json. You can use a simple dot notation `skills.name` or a JsonPath expression such as `$.name;$.locations.country.name`. For more advanced options, see JsonPath Filtering for syntax.
`↳ onlyMatches`boolean	Return only records that have a match
`error`boolean	`true` if error

400Invalid bulkjobId
`code`integer (int32)	Status code (same as the HTTP status code)
`message`string	Status message
`request_ctx`object	Request context
`↳ query`object \| object \| string	Submitted query
`↳ type`string	Diffbot entity type
`↳ name`string[]	Name of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ url`string[]	Origin or homepage URI of entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ location`string	Location of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ ip`string	IP address of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ phone`string	Phone of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ description`string	Description of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ email`string[]	Email of the entity to enhance. Parameter can be used only with type `Person`
`↳ employer`string	Employer of the entity to enhance. Parameter can be used only with type `Person`
`↳ title`string	Title of the entity to enhance. Parameter can be used only with type `Person`
`↳ school`string	School of the entity to enhance. Parameter can be used only with type `Person`
`↳ query_ctx`object	Query context. Example: submitted query parameters etc.
`bulkjobStatus`object	Bulkjob status
`↳ job_id`string	Bulkjob Id
`↳ name`string	Bulkjob name
`↳ refresh`boolean	Is Refresh enabled for this job?
`↳ search`string	Is Search enabled for this job?
`↳ message`string	Bulkjob status message
`↳ jobs_total`integer (int32)	Number of jobs in bulkjob
`↳ jobs_completed`integer (int32)	Number of jobs completed in bulkjob.
`↳ status`string	Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN}
`↳ estimate_remaining_time`integer (int64)	Estimated remaining time for bulkjob to complete (in seconds). `null` if job is completed or not started.
`↳ submit_time_ms`integer (int64)	Bulkjob submit time
`↳ start_time_ms`integer (int64)	Bulkjob start time
`↳ completed_time_ms`integer (int64)	Bulkjob completed time
`↳ total_results`integer (int32)	Total results
`↳ bulkjobId`string
`↳ totalJobs`integer (int32)
`↳ finishedJobs`integer (int32)
`↳ estimateRemainingTimeSec`integer (int64)
`↳ submitTimeMs`integer (int64)
`↳ startTimeMs`integer (int64)
`↳ completedTimeMs`integer (int64)
`↳ totalResults`integer (int32)
`↳ fileSizeBytes`integer (int64)	Size of download file in bytes
`↳ reports`object[]	Coverage reports generated for this bulkjob
`↳ reportId`string	Coverage Report ID
`↳ status`string	Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN}
`↳ format`string	Export format
`↳ spec`string	The spec defines the columns to export. This is applicable for csv, xls and xslx formats. Export spec specifies how to export the entity JSON to a csv. A simple export spec looks like `name;summary`. To specify more complex export spec, including specifying how many of a list of `industries` to return, or the ideal `employment` record, see Exporting Columnar Format and JsonPath Filtering.
`↳ exportfile`string
`↳ exportSeparator`string	Separator for multi-value fields when exporting columnar results
`↳ filter`string	Semi-colon separated path filter to filter response json. You can use a simple dot notation `skills.name` or a JsonPath expression such as `$.name;$.locations.country.name`. For more advanced options, see JsonPath Filtering for syntax.
`↳ onlyMatches`boolean	Return only records that have a match
`error`boolean	`true` if error

401Token not specified or other client errors
`requestId`string	Identifier of the rejected request, also returned in the `X-Diffbot-RequestId` header
`code`integer (int32)	Status code (same as the HTTP status code)
`message`string	Status message

404Bulkjob not found
`code`integer (int32)	Status code (same as the HTTP status code)
`message`string	Status message
`request_ctx`object	Request context
`↳ query`object \| object \| string	Submitted query
`↳ type`string	Diffbot entity type
`↳ name`string[]	Name of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ url`string[]	Origin or homepage URI of entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ location`string	Location of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ ip`string	IP address of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ phone`string	Phone of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ description`string	Description of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ email`string[]	Email of the entity to enhance. Parameter can be used only with type `Person`
`↳ employer`string	Employer of the entity to enhance. Parameter can be used only with type `Person`
`↳ title`string	Title of the entity to enhance. Parameter can be used only with type `Person`
`↳ school`string	School of the entity to enhance. Parameter can be used only with type `Person`
`↳ query_ctx`object	Query context. Example: submitted query parameters etc.
`bulkjobStatus`object	Bulkjob status
`↳ job_id`string	Bulkjob Id
`↳ name`string	Bulkjob name
`↳ refresh`boolean	Is Refresh enabled for this job?
`↳ search`string	Is Search enabled for this job?
`↳ message`string	Bulkjob status message
`↳ jobs_total`integer (int32)	Number of jobs in bulkjob
`↳ jobs_completed`integer (int32)	Number of jobs completed in bulkjob.
`↳ status`string	Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN}
`↳ estimate_remaining_time`integer (int64)	Estimated remaining time for bulkjob to complete (in seconds). `null` if job is completed or not started.
`↳ submit_time_ms`integer (int64)	Bulkjob submit time
`↳ start_time_ms`integer (int64)	Bulkjob start time
`↳ completed_time_ms`integer (int64)	Bulkjob completed time
`↳ total_results`integer (int32)	Total results
`↳ bulkjobId`string
`↳ totalJobs`integer (int32)
`↳ finishedJobs`integer (int32)
`↳ estimateRemainingTimeSec`integer (int64)
`↳ submitTimeMs`integer (int64)
`↳ startTimeMs`integer (int64)
`↳ completedTimeMs`integer (int64)
`↳ totalResults`integer (int32)
`↳ fileSizeBytes`integer (int64)	Size of download file in bytes
`↳ reports`object[]	Coverage reports generated for this bulkjob
`↳ reportId`string	Coverage Report ID
`↳ status`string	Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN}
`↳ format`string	Export format
`↳ spec`string	The spec defines the columns to export. This is applicable for csv, xls and xslx formats. Export spec specifies how to export the entity JSON to a csv. A simple export spec looks like `name;summary`. To specify more complex export spec, including specifying how many of a list of `industries` to return, or the ideal `employment` record, see Exporting Columnar Format and JsonPath Filtering.
`↳ exportfile`string
`↳ exportSeparator`string	Separator for multi-value fields when exporting columnar results
`↳ filter`string	Semi-colon separated path filter to filter response json. You can use a simple dot notation `skills.name` or a JsonPath expression such as `$.name;$.locations.country.name`. For more advanced options, see JsonPath Filtering for syntax.
`↳ onlyMatches`boolean	Return only records that have a match
`error`boolean	`true` if error

500Internal Server Error
`code`integer (int32)	Status code (same as the HTTP status code)
`message`string	Status message
`request_ctx`object	Request context
`↳ query`object \| object \| string	Submitted query
`↳ type`string	Diffbot entity type
`↳ name`string[]	Name of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ url`string[]	Origin or homepage URI of entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ location`string	Location of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ ip`string	IP address of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ phone`string	Phone of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ description`string	Description of the entity to enhance. Parameter can be used with types `Person` and `Organization`
`↳ email`string[]	Email of the entity to enhance. Parameter can be used only with type `Person`
`↳ employer`string	Employer of the entity to enhance. Parameter can be used only with type `Person`
`↳ title`string	Title of the entity to enhance. Parameter can be used only with type `Person`
`↳ school`string	School of the entity to enhance. Parameter can be used only with type `Person`
`↳ query_ctx`object	Query context. Example: submitted query parameters etc.
`bulkjobStatus`object	Bulkjob status
`↳ job_id`string	Bulkjob Id
`↳ name`string	Bulkjob name
`↳ refresh`boolean	Is Refresh enabled for this job?
`↳ search`string	Is Search enabled for this job?
`↳ message`string	Bulkjob status message
`↳ jobs_total`integer (int32)	Number of jobs in bulkjob
`↳ jobs_completed`integer (int32)	Number of jobs completed in bulkjob.
`↳ status`string	Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN}
`↳ estimate_remaining_time`integer (int64)	Estimated remaining time for bulkjob to complete (in seconds). `null` if job is completed or not started.
`↳ submit_time_ms`integer (int64)	Bulkjob submit time
`↳ start_time_ms`integer (int64)	Bulkjob start time
`↳ completed_time_ms`integer (int64)	Bulkjob completed time
`↳ total_results`integer (int32)	Total results
`↳ bulkjobId`string
`↳ totalJobs`integer (int32)
`↳ finishedJobs`integer (int32)
`↳ estimateRemainingTimeSec`integer (int64)
`↳ submitTimeMs`integer (int64)
`↳ startTimeMs`integer (int64)
`↳ completedTimeMs`integer (int64)
`↳ totalResults`integer (int32)
`↳ fileSizeBytes`integer (int64)	Size of download file in bytes
`↳ reports`object[]	Coverage reports generated for this bulkjob
`↳ reportId`string	Coverage Report ID
`↳ status`string	Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN}
`↳ format`string	Export format
`↳ spec`string	The spec defines the columns to export. This is applicable for csv, xls and xslx formats. Export spec specifies how to export the entity JSON to a csv. A simple export spec looks like `name;summary`. To specify more complex export spec, including specifying how many of a list of `industries` to return, or the ideal `employment` record, see Exporting Columnar Format and JsonPath Filtering.
`↳ exportfile`string
`↳ exportSeparator`string	Separator for multi-value fields when exporting columnar results
`↳ filter`string	Semi-colon separated path filter to filter response json. You can use a simple dot notation `skills.name` or a JsonPath expression such as `$.name;$.locations.country.name`. For more advanced options, see JsonPath Filtering for syntax.
`↳ onlyMatches`boolean	Return only records that have a match
`error`boolean	`true` if error

Authentication

Custom API

Manage a Crawl JobGET

Bulk Enhance API

Download Results of Bulkjob

Example

API Definition

Request

Example request

Response

Download Results of Bulkjob ​

Example ​

API Definition

Request

Example request

Response

Download Results of Bulkjob

Example