User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Retrieve a Dataset's Status

Get status information for whether a dataset is streamable

This endpoint describes the dataset requested and whether the dataset "is streamable." This refers to whether the records in the dataset are up-to-date and ready to be downloaded. If the dataset is out of date, and thus not streamable, then it should be refreshed before streaming.

Response Fields

This endpoint returns a JSON object describing the requested dataset.

FieldDescription
datasetNameThe name of the dataset. Will either be user-given, or Tamr generated to reflect which project and step the dataset is associated with.
relativeDatasetIdThe ID of the dataset stripped of the instance name. This ID can be used in API calls.
isStreamableBoolean value. Whether the dataset is streamable.
Language