MENU
      Get shopping intent list
        • PDF

        Get shopping intent list

        • PDF

        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        indexIntegerOptionalStart location of the list
        • Default: 0
        limitIntegerOptionalList output limit value
        • 1-100 (default: 20)

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

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        indexInteger-Start location of the list
        limitInteger-List output limit value
        totalInteger-Number of retrieved profiles
        profilesArray-Profile list

        profiles

        The following describes profiles.

        FieldTypeRequiredDescription
        profile_idString-Profile ID
        profile_nameString-Profile name
        task_idString-Task ID to apply for profiling
        task_nameString-Task name to apply for profiling
        statusString-Profile status
        • registered | pending | in_progress | completed | failed
          • registered: registered
          • pending: pending
          • in_progress: creating
          • completed: available
          • failed: failed
        created_atString-Profile creation request date and time (ISO 8601 format)
        completed_atString-Profile creation completion date and time (ISO 8601 format)
        line_countInteger-Number of lines of the feature applied to the task
        disk_usageInteger-Capacity (byte) of the profile
        fail_messageString-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)
            ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.