Get shopping intent
- Print
- PDF
Get shopping intent
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and 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.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | /api/v1/profile/shopping-intents/{profile_id} |
Request headers
For information about the headers common to all NCLUE APIs, see Common NCLUE 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 of the shopping intent entered by the user |
task_id | String | - | ID of the task to check the profile results, which is entered when creating a shopping intent |
task_name | String | - | Name of task to check the profile results |
status | String | - | Creation type
|
created_at | String | - | Shopping intent creation request date (ISO 8601 format) |
completed_at | String | - | Shopping intent creation job completion date (ISO 8601 format) |
line_count | Integer | - | Number of lines of the feature integrated with the task used to create the shopping intent |
disk_usage | Integer | - | Capacity (byte) of the created profile |
fail_message | String | - | Message upon creation failure. See Troubleshooting NCLUE |
Response example
The response example is as follows:
Succeeded
The following is a sample response upon a successful call.
{
"profile_id":"bce6d560-99ce-4a26-809d-03f750371d52",
"profile_name":"Pet food user profiling",
"task_id":"b5e742f1-0558-465a-8485-3b7808b0e125",
"task_name":"Prediction model for pet food purchase interest",
"status":"completed",
"created_at":"2024-11-04T11:02:34",
"completed_at":"2024-11-04T11:09:03",
"line_count": 1209478,
"disk_usage": 22060,
"fail_message":null
}
Failure
For examples of responses in the event of a failed call, see Response status codes.
Was this article helpful?