Returns aggregated summaries of all datasets matching the specified filters (if any).

Query parameters

NameTypeDescriptionRequired?
filter array Returns only datasets where the specified attribute matches the specified value1. Currently display_name, created_at, data_updated_at, and schema_updated_at are the only attributes supported. You cannot combine this parameter with the query parameter. Note that date comparisons are always non-inclusive, so data_updated_at<=2018-04-06 is the same as data_updated_at<2018-04-06. false
has_tag array Returns only datasets tagged with the specified tag names (for example, construction or real%20estate). If you specify multiple tags, the API returns datasets with any of the tags (OR). false
in_collection_id string Works in conjunction with query and returns only rows from datasets within the specified collection (including its child collections). false
include_serialids boolean Set to true to include the Enigma Serial ID field in the row data (default is false). The serial ID is row identifier added by Enigma that is unique within the current snapshot. false
match_metadata boolean Works in conjunction with query. When true, the API searches for datasets where there is a match within the dataset metadata. When false, the API does not search the metadata for matches. Default is true. false
match_rows boolean Works in conjunction with query. When true, the API searches for datasets where there is a match within the data records (rows). When false, the API does not search the data records for matches. Default is true. false
max_row_count integer Returns only datasets with less than the specified number of rows. false
min_row_count integer Returns only datasets with at least the specified number of rows. false
mode string Values: advanced phrase simple
Defaults to simple.
false
parent_collection_id array Returns only datasets whose immediate parent collection ID matches the one specified here. You can use this to identify all the datasets, plus the current snapshot ID for each, within a given collection. false
phrase_distance integer If mode is set to phrase, this specifies the proximity search distance. For example, if query is sovereign%20country and phrase_distance=0, the two words must be next to each other. If phrase_distance=1, it also matches 'sovereign island country'. false
query string Query string to return only rows that contain specific information (must set row_limit > 0)3. You cannot combine this with the filter parameter. false
row_limit integer Number of rows to return for each dataset (default is 0; maximum 10,000). false
row_offset integer Number of rows to skip at the beginning of the snapshot (for example, row_offset=10 skips the first 10 rows). false
row_sort string Specifies the field used to sort the records within the dataset (must set row_limit > 0). If you specify row_offset as well, the records are sorted first and then the offset is applied. Prepend the field name with a minus sign (-) to specify descending order (defaults to ascending). false
sort array List of dataset attributes indicating how to sort the datasets2. display_name, created_at, data_updated_at, and schema_updated_at are supported. For example, -created_at sorts the datasets by creation date, with the most recent listed first. display_name is the default sort attribute. You cannot combine this with the query parameter. false

1 See “Using the filter parameter” on GET /datasets/.

Try it out

Enter any desired query parameters and click Send to view the response:

GET https://public.enigma.com/api/dataset_summary?


Responses

CodeReturns
200 Aggregated summaries

Example

$ curl -X GET 'https://public.enigma.com/api/dataset_summary?query=enigma%20technologies'