API Reference

Coverage report by Query

get
https://kg.diffbot.com/kg/v3/dql/report

Download coverage report by DQL query

Query Params
string
required

DQL Query

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

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

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.

Responses

Updated 6 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/csv

Updated 6 months ago