Get dataset list

Prev Next

Available in Classic and VPC

Get the list of all created datasets.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /datasets

Request headers

For headers common to all AiTEMS APIs, see Common AiTEMS headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
offset Integer Optional Start location of query data
  • Default: 0
limit Integer Optional Maximum number of query data
  • Default: 1000

Request example

The following is a sample request.

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/datasets' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

Response

The following describes the response format.

Response body

The following describes the response body.

Field Type Required Description
datasets Array - Dataset information
offset Integer - Start location of query data
limit Integer - Maximum number of query data

datasets

The following describes datasets.

Field Type Required Description
datasetId String - Unique ID assigned to the dataset
type String - Dataset type
  • user | item | interaction
    • user: data containing user information (age, gender, etc.)
    • item: data with product-related information (price, release date, category, etc.)
    • interaction: data that captures the history of interactions between users and products
name String - Dataset name
status String - Dataset status
  • enable | waiting | processing | upload_failed | disable | deleting
    • enable: training available
    • waiting, processing: pending
    • upload_failed, disable, deleting: upload failure
createdDate String - Dataset creation date and time
actionName String - Sub Account permissions for the queried item
permission String - Sub Account permission allowance

Response status codes

For response status codes common to all AiTEMS APIs, see Common AiTEMS API response status codes.

Response example

The following is a sample example.

{
    "datasets": [
        {
            "datasetId": "bu457******",
            "type": "interaction",
            "name": "interaction_dataset",
            "status": "enable",
            "createdDate": "2024-07-30T09:49:19.254",
            "actionName": "View/getDatasetDetail",
            "permission": "Allow"
        },
        {
            "datasetId": "oeq4i******",
            "type": "user",
            "name": "user_dataset",
            "status": "enable",
            "createdDate": "2024-07-30T08:58:00.662",
            "actionName": "View/getDatasetDetail",
            "permission": "Allow"
        },
        {
            "datasetId": "g8rf6******",
            "type": "item",
            "name": "item_dataset",
            "status": "enable",
            "createdDate": "2024-07-29T16:46:35.968",
            "actionName": "View/getDatasetDetail",
            "permission": "Allow"
        }
    ],
    "offset": 0,
    "limit": 1000
}