Search with DQL

Search the Knowledge Graph using DQL

Query Params
string
enum
Defaults to query

Query type

Allowed:
string
required

DQL Query

string
Defaults to all

Comma-delimited list of custom crawl collections to query. Specify all to query all collections for your token. This parameter is valid only when type=crawl and defaults to all

int32
Defaults to 0

Return results starting at from index. from+size <= 10_000 for facet queries.

Please note that the from parameter is no longer applicable to Article queries and has been deprecated. In the future, using this parameter will result in an error.

int32
Defaults to 50

Maximum number of results to return. -1 to return all results. from+size <= 10_000 for facet queries.

string
enum
Defaults to json

Output format

Allowed:
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.

string

The export separator

string

For export endpoint, The file name of the export file

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 such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

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 such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

string
enum
Defaults to

extended returns origin information for facts. id returns just the diffbotIds and origins.

Allowed:
boolean
Defaults to false

nonCanonicalFacts=true returns non-canonical facts.

boolean
Defaults to false

noDedupArticles=true indicates that articles should not be deduplicated but all of them returned

string
enum
Defaults to

Articles only. Utilize Diffbot clustering algorithms to identify related or similar objects.
- cluster=all to return each article with a clusterId identifying thematically-similar articles.
- cluster=best to remove thematically-similar articles from the result set, leaving a single best representative from each cluster.

- cluster=dedupe to remove exact and near-duplicate articles from the result set. Where applicable, clusterId is returned in the entity_ctx element of each response entity.

Allowed:
boolean
Defaults to false

Generate coverage report. See [dql-coverage-reports](Coverage Reports) for more details on generating coverage reports for DQL queries.

string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/json-lines
text/csv
application/ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet