Shopping Intentリストの照会

VPC環境で利用できます。

作成した Shopping Intentの Profileリストを照会します。照会されたすべての Profileの詳細情報を確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/profile/shopping-intents

リクエストヘッダ

NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`index`	Integer	Optional	リストのスタート位置デフォルト: 0
`limit`	Integer	Optional	リストの出力制限値 1~100(デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`index`	Integer	-	リストのスタート位置
`limit`	Integer	-	リストの出力制限値
`total`	Integer	-	照会された Profile数
`profiles`	Array	-	Profileリスト

`profiles`

profilesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`profile_id`	String	-	Profile ID
`profile_name`	String	-	Profile名
`task_id`	String	-	プロファイリングに適用する Task ID
`task_name`	String	-	プロファイリングに適用する Task名
`status`	String	-	Profileの状態 `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: 登録完了 `pending`: 待機中 `in_progress`: 作成中 `completed`: 使用可能 `failed`: 失敗
`created_at`	String	-	Profile作成リクエスト日時(ISO 8601形式)
`completed_at`	String	-	Profile作成完了日時(ISO 8601形式)
`line_count`	Integer	-	Taskに適用された Featureのライン数
`disk_usage`	Integer	-	Profile容量(Byte)
`fail_message`	String	-	作成失敗メッセージメッセージ別解決方法はNCLUEのトラブルシューティングを参照

レスポンスステータスコード

NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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
        },
        // (省略)
    ]
}