Get shopping intent

Prev Next

Available in VPC

Get the profile details of created shopping intent. You can check the progress of the profile you requested to create and the task model used when creating the profile. If the creation fails, you can see the error message.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /profile/shopping-intents/{profile_id}

Request headers

For information about the headers common to all NCLUE APIs, see NCLUE request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
profile_id String Required Profile ID

Request example

The request example is as follows:

curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/profile/shopping-intents/{profile_id}' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
profile_id String - Profile ID
profile_name String - Profile name
task_id String - Task ID to apply for profiling
task_name String - Task name to apply for profiling
status String - Profile status
  • registered | pending | in_progress | completed | failed
    • registered: registered
    • pending: pending
    • in_progress: creating
    • completed: available
    • failed: failed
created_at String - Profile creation request date and time (ISO 8601 format)
completed_at String - Profile creation completion date and time (ISO 8601 format)
line_count Integer - Number of lines of the feature applied to the task
disk_usage Integer - Capacity (byte) of the profile
fail_message String - Creation failure message

Response status codes

For response status codes common to NCLUE, see NCLUE response status codes.

Response example

The response example is as follows:

{
    "profile_id": "cb4bc383-****-****-****-adeffdab602e",
    "profile_name": "YOUR_PROFILE_NAME",
    "task_id": "3dd950b2-****-****-****-64a7c54bd0e7",
    "task_name": "YOUR_TASK_NAME",
    "status": "completed",
    "created_at": "2024-10-18T01:25:35",
    "completed_at": "2024-10-18T01:28:09",
    "line_count": 9367,
    "disk_usage": 22060,
    "fail_message": null
}