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

Retrieve Downstream Dataset Usage

Report usages of a dataset by recipes and downstream datasets

Response Fields

Returns a JSON object with information about which specific project steps and datasets rely on the dataset in question. Both the usage and dependencies fields are lists of JSON objects containing the following:

Field

Description

datasetId

The deployment-specific ID of the dataset returned. Unique across the entire deployment of Tamr.

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.

inputToProjectSteps

A list of all project steps to which the dataset is used as input.

outputToProjectSteps

A list of all project steps from which the dataset is output.

In addition, each project step listed in either inputToProjectSteps or outputToProjectStepscontain the following fields:

Field

Description

projectStepId

The extended ID of the project step in which the dataset is used. Unique across the entire instance of Tamr.

projectStepName

The name of the projectStep. Defined by the projectName appended by the type.

projectName

The name of the project with which the step is associated.

type

The type of project step in which the dataset is used.

Language