Returns the specified dataset.

By default you don’t get any snapshot data. If you set row_limit > 0, the API returns the specified number of data records (rows) from the current snapshot as well (maximum 10,000 rows).

If you specify a query string, the endpoint returns matching rows from the current snapshot, as well as positional information indicating where instances of the specified query string occur (you can use this to highlight text in the search results). You must set row_limit > 0.

Required arguments

Name Type Description
id string The [dataset ID][public_v20_api_uuids].

Optional keyword arguments

NameTypeDescription
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.
mode
string Values: advanced phrase simple
Defaults to simple.
phrase_distance
integer If mode is phrase, this specifies the proximity search distance. For example, if query is set to 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'.
query
string Query string to return only rows that contain specific information (must set row_limit > 0).
row_limit
integer Number of rows to return (defaults to 0; maximum 10,000).
row_offset
integer Number of rows to skip at the beginning of the snapshot (for example, row_offset=10 skips the first 10 rows).
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).

Returns

The dataset model.

Example

This example gets the dataset with the specified ID.

public = enigma.Public()
dataset = public.datasets.get('de8af1e6-f4f0-4762-b5a3-d85d3c3f0967')