get http://<host>:9100/api/versioned/v1/datasets//profile
Get profile info for a dataset, if available
This endpoint retrieves profiling information for a dataset, if it exists. If it does not, use the Profile a Dataset endpoint or the Profiling a Dataset UI interaction to generate the information.
Response Fields
Returns a JSON object describing the dataset, including individual information for each attribute. Each attribute in the dataset is represented by one JSON entry in the list of attributeProfiles
.
Field | Description |
---|---|
datasetName | The name of the profiled dataset. |
relativeDatasetId | The ID of the dataset stripped of the instance name. This ID can be used in API calls. |
isUpToDate | A boolean value describing whether the dataset has been profiled since the most recent update. |
profiledDataVersion | The version of the dataset profile information. |
profiledAt | A list of information about the most recent profile of the dataset. |
simpleMetrics | A list of metrics describing the dataset as a whole. |
attributeProfiles | A list of JSON objects describing the profile information for each attribute of the dataset. |