Get shopping intent list
- Print
- PDF
Get shopping intent list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Get the profile list of created shopping intent. You can check the detailed information of all retrieved profiles.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | /profile/shopping-intents |
Request headers
For information about the headers common to all NCLUE APIs, see NCLUE request headers.
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
index | Integer | Optional | Start location of the list
|
limit | Integer | Optional | List output limit value
|
Request example
The request example is as follows:
curl --location --request GET 'https://nclue.apigw.ntruss.com/api/v1/profile/shopping-intents?index=0&limit=20' \
--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 |
|---|---|---|---|
index | Integer | - | Start location of the list |
limit | Integer | - | List output limit value |
total | Integer | - | Number of retrieved profiles |
profiles | Array | - | Profile list |
profiles
The following describes profiles.
| 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
|
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:
{
"index": 0,
"limit": 20,
"total": 2,
"profiles": [
{
"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
},
// (Omitted)
]
}
Was this article helpful?