Retrieves statistics for metadata in a dataset.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
paidataset:GetDatasetFileMetasStatistics |
get |
*All Resource
|
None | None |
Request syntax
GET /api/v1/statistics/datasets/{DatasetId}/datasetfilemetas HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DatasetId |
string |
Yes |
The dataset ID. For more information about how to obtain a dataset ID, see ListDatasets. |
d-rbvg5wz****c9ks92 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DatasetVersion |
string |
Yes |
The name of the dataset version. |
v1 |
| WorkspaceId |
string |
Yes |
The workspace ID. For more information about how to obtain a workspace ID, see ListWorkspaces. |
145883 |
| AggregateBy |
string |
No |
The metadata field used for statistical aggregation. The value is not case-sensitive. If you do not specify this parameter, the total number of file metadata entries in the dataset is returned, and the aggregation list is not returned. Valid values:
Valid values:
|
filedir |
| MaxResults |
integer |
No |
The maximum number of results to return for each query that uses the NextToken parameter. Valid values: 1 to 100. Default value: 10. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| requestId |
string |
The request ID. |
ADF6D849-*****-7E7030F0CE53 |
| TotalCount |
integer |
The number of statistical results returned. For example, the number of metadata entries or the number of user tags. |
73 |
| DatasetFileMetasStats |
array |
The details of the returned aggregation list. You can get the count for each aggregated item. The list is sorted by Count in descending order by default. |
|
|
DatasetFileMetasStat |
The aggregated item and its count. |
Examples
Success response
JSON format
{
"requestId": "ADF6D849-*****-7E7030F0CE53",
"TotalCount": 73,
"DatasetFileMetasStats": [
{
"Key": "cat",
"Count": 10
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.