HomeTamr Core GuidesTamr Core API Reference
Tamr Core GuidesTamr Core API ReferenceTamr Core TutorialsEnrichment API ReferenceSupport Help CenterLog In

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.

Field

Description

datasetName

The name of the dataset. Will either be user-given, or Tamr generated to reflect which project and step the dataset is associated with.

relativeDatasetId

The ID of the dataset stripped of the instance name. This ID can be used in API calls.

isStreamable

Boolean value. Whether the dataset is streamable.

Language