Enrich a person record and return both person and current employer data
Request
| Authentication | |
|---|---|
token | Cache and insert token into example requests (15d expiry) |
| Query parameters | |
|---|---|
type | Diffbot entity type One of: |
name | Name of the entity to enhance. Parameter can be used with types |
url | Origin or homepage URI of entity to enhance. Parameter can be used with types |
phone | Phone of the entity to enhance. Parameter can be used with types |
email | Email of the entity to enhance. Parameter can be used only with type |
employer | Employer of the entity to enhance. Parameter can be used only with type |
title | Title of the entity to enhance. Parameter can be used only with type |
school | School of the entity to enhance. Parameter can be used only with type |
location | Location of the entity to enhance. Parameter can be used with types |
ip | IP address of the entity to enhance. Parameter can be used with types |
customId | User defined ID for correlation |
threshold | Enhance similarity threshold |
refresh |
|
search |
|
nonCanonicalFacts |
|
jsonmode |
One of: |
filter | Semi-colon separated path filter to filter response json. You can use a simple dot notation |
filterExclude | Semi-colon separated path filter to filter and exclude data from response json. You can use a simple dot notation |
Example request
curl --request GET \
--url 'https://kg.diffbot.com/kg/v3/enhance/combine?type=Person&refresh=false&search=false&nonCanonicalFacts=false&token=<DIFFBOT_TOKEN>' \
--header 'Accept: application/json'
Response
| 200Enhanced entity | |
|---|---|
version | Response version |
hits | Number of matches returned |
kgversion | Version of KG that was queried |
request_ctx | Request context |
query | Submitted query |
type | Diffbot entity type |
name | Name of the entity to enhance. Parameter can be used with types |
url | Origin or homepage URI of entity to enhance. Parameter can be used with types |
location | Location of the entity to enhance. Parameter can be used with types |
ip | IP address of the entity to enhance. Parameter can be used with types |
phone | Phone of the entity to enhance. Parameter can be used with types |
description | Description of the entity to enhance. Parameter can be used with types |
email | Email of the entity to enhance. Parameter can be used only with type |
employer | Employer of the entity to enhance. Parameter can be used only with type |
title | Title of the entity to enhance. Parameter can be used only with type |
school | School of the entity to enhance. Parameter can be used only with type |
query_ctx | Query context. Example: submitted query parameters etc. |
data | |
score | Enhance score |
esscore | |
entity | Enhanced entity. Can be null if no entity was found. |
errors | |
refreshInfo | Refresh info for debug |
refreshDelta | |
entity_ctx | Entity-level context |
errors | |
searchInfo | Search info for debug |
| 400Error parsing request | |
|---|---|
code | Status code (same as the HTTP status code) |
message | Status message |
request_ctx | Request context |
query | Submitted query |
type | Diffbot entity type |
name | Name of the entity to enhance. Parameter can be used with types |
url | Origin or homepage URI of entity to enhance. Parameter can be used with types |
location | Location of the entity to enhance. Parameter can be used with types |
ip | IP address of the entity to enhance. Parameter can be used with types |
phone | Phone of the entity to enhance. Parameter can be used with types |
description | Description of the entity to enhance. Parameter can be used with types |
email | Email of the entity to enhance. Parameter can be used only with type |
employer | Employer of the entity to enhance. Parameter can be used only with type |
title | Title of the entity to enhance. Parameter can be used only with type |
school | School of the entity to enhance. Parameter can be used only with type |
query_ctx | Query context. Example: submitted query parameters etc. |
bulkjobStatus | Bulkjob status |
job_id | Bulkjob Id |
name | Bulkjob name |
refresh | Is Refresh enabled for this job? |
search | Is Search enabled for this job? |
message | Bulkjob status message |
jobs_total | Number of jobs in bulkjob |
jobs_completed | Number of jobs completed in bulkjob. |
status | Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN} |
estimate_remaining_time | Estimated remaining time for bulkjob to complete (in seconds). |
submit_time_ms | Bulkjob submit time |
start_time_ms | Bulkjob start time |
completed_time_ms | Bulkjob completed time |
total_results | Total results |
bulkjobId | |
totalJobs | |
finishedJobs | |
estimateRemainingTimeSec | |
submitTimeMs | |
startTimeMs | |
completedTimeMs | |
totalResults | |
fileSizeBytes | Size of download file in bytes |
reports | Coverage reports generated for this bulkjob |
reportId | Coverage Report ID |
status | Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN} |
format | Export format |
spec | 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 |
exportfile | |
exportSeparator | Separator for multi-value fields when exporting columnar results |
filter | Semi-colon separated path filter to filter response json. You can use a simple dot notation |
onlyMatches | Return only records that have a match |
error |
|
| 401Token not specified or other client errors | |
|---|---|
requestId | Identifier of the rejected request, also returned in the |
code | Status code (same as the HTTP status code) |
message | Status message |
| 429Insufficient credits | |
|---|---|
code | Status code (same as the HTTP status code) |
message | Status message |
request_ctx | Request context |
query | Submitted query |
type | Diffbot entity type |
name | Name of the entity to enhance. Parameter can be used with types |
url | Origin or homepage URI of entity to enhance. Parameter can be used with types |
location | Location of the entity to enhance. Parameter can be used with types |
ip | IP address of the entity to enhance. Parameter can be used with types |
phone | Phone of the entity to enhance. Parameter can be used with types |
description | Description of the entity to enhance. Parameter can be used with types |
email | Email of the entity to enhance. Parameter can be used only with type |
employer | Employer of the entity to enhance. Parameter can be used only with type |
title | Title of the entity to enhance. Parameter can be used only with type |
school | School of the entity to enhance. Parameter can be used only with type |
query_ctx | Query context. Example: submitted query parameters etc. |
bulkjobStatus | Bulkjob status |
job_id | Bulkjob Id |
name | Bulkjob name |
refresh | Is Refresh enabled for this job? |
search | Is Search enabled for this job? |
message | Bulkjob status message |
jobs_total | Number of jobs in bulkjob |
jobs_completed | Number of jobs completed in bulkjob. |
status | Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN} |
estimate_remaining_time | Estimated remaining time for bulkjob to complete (in seconds). |
submit_time_ms | Bulkjob submit time |
start_time_ms | Bulkjob start time |
completed_time_ms | Bulkjob completed time |
total_results | Total results |
bulkjobId | |
totalJobs | |
finishedJobs | |
estimateRemainingTimeSec | |
submitTimeMs | |
startTimeMs | |
completedTimeMs | |
totalResults | |
fileSizeBytes | Size of download file in bytes |
reports | Coverage reports generated for this bulkjob |
reportId | Coverage Report ID |
status | Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN} |
format | Export format |
spec | 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 |
exportfile | |
exportSeparator | Separator for multi-value fields when exporting columnar results |
filter | Semi-colon separated path filter to filter response json. You can use a simple dot notation |
onlyMatches | Return only records that have a match |
error |
|
| 500Internal Server Error | |
|---|---|
code | Status code (same as the HTTP status code) |
message | Status message |
request_ctx | Request context |
query | Submitted query |
type | Diffbot entity type |
name | Name of the entity to enhance. Parameter can be used with types |
url | Origin or homepage URI of entity to enhance. Parameter can be used with types |
location | Location of the entity to enhance. Parameter can be used with types |
ip | IP address of the entity to enhance. Parameter can be used with types |
phone | Phone of the entity to enhance. Parameter can be used with types |
description | Description of the entity to enhance. Parameter can be used with types |
email | Email of the entity to enhance. Parameter can be used only with type |
employer | Employer of the entity to enhance. Parameter can be used only with type |
title | Title of the entity to enhance. Parameter can be used only with type |
school | School of the entity to enhance. Parameter can be used only with type |
query_ctx | Query context. Example: submitted query parameters etc. |
bulkjobStatus | Bulkjob status |
job_id | Bulkjob Id |
name | Bulkjob name |
refresh | Is Refresh enabled for this job? |
search | Is Search enabled for this job? |
message | Bulkjob status message |
jobs_total | Number of jobs in bulkjob |
jobs_completed | Number of jobs completed in bulkjob. |
status | Status of Bulkjob. One of {NOT_STARTED, IN_PROCESS, COMPLETE, COMPLETE_WITH_FAILURES, STOPPED, ERROR_FINALIZING, UNKNOWN} |
estimate_remaining_time | Estimated remaining time for bulkjob to complete (in seconds). |
submit_time_ms | Bulkjob submit time |
start_time_ms | Bulkjob start time |
completed_time_ms | Bulkjob completed time |
total_results | Total results |
bulkjobId | |
totalJobs | |
finishedJobs | |
estimateRemainingTimeSec | |
submitTimeMs | |
startTimeMs | |
completedTimeMs | |
totalResults | |
fileSizeBytes | Size of download file in bytes |
reports | Coverage reports generated for this bulkjob |
reportId | Coverage Report ID |
status | Status of report generation. One of {NOT_STARTED, IN_PROCESS, COMPLETE, UNKNOWN} |
format | Export format |
spec | 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 |
exportfile | |
exportSeparator | Separator for multi-value fields when exporting columnar results |
filter | Semi-colon separated path filter to filter response json. You can use a simple dot notation |
onlyMatches | Return only records that have a match |
error |
|