Get custom attributes list
    • PDF

    Get custom attributes list

    • PDF

    Article summary

    Available in Classic and VPC

    Get the profile list of created custom attributes.

    Request

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

    MethodURI
    GET/api/v1/profile/custom-attributes

    Request headers

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

    Request query parameters

    You can use the following query parameters with your request:

    FieldTypeRequiredDescription
    indexIntegerOptionalStart location of profile list
    • Default: 0
    limitIntegerOptionalProfile list 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/custom-attributes?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:

    FieldTypeRequiredDescription
    indexInteger-Page index (0 - N)
    limitInteger-Profile list output limit value (1 - 100)
    totalInteger-Total number of profiles created by the user
    profiles.profile_idString-Profile ID
    profiles.profile_nameString-Profile name of the custom attributes entered by the user
    profiles.feature_idString-Feature ID to be profiled, enter when creating custom attributes
    profiles.feature_nameString-Feature name to profile
    profiles.keyword_setString-A list of attribute keywords entered by the user (keywords to check similarity with the target user)
    profiles.statusString-Creation type
    • registered | pending | in_progress | completed | failed
      • registered: registered
      • pending: pending
      • in_progress: creating
      • completed: available
      • failed: failed
    profiles.created_atString-Custom attributes creation request date (ISO 8601 format)
    profiles.completed_atString-Custom attributes creation completion date (ISO 8601 format)
    profiles.result_bucketString-Name of the Object Storage bucket to store custom attributes job results
    profiles.result_file_pathString-File path to save the results in the result_bucket bucket
    profiles.line_countInteger-Number of lines of the feature used to create custom attributes
    profiles.fail_messageString-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.

    {
        "index": 0,
        "limit": 20,
        "total: 172,
        "profiles": [
            {
                "profile_id":"efc3f714-d267-44e2-a574-75497cc7712c",
                "profile_name":"Running profiling",
                "feature_id":"79eb85b5-8ec5-4e1a-8617-64a1977c8062",
                "feature_name":"Shopping behavior sequence - 2024",
                "keyword_set":"Running, run, marathon, jogging, running shoes, running socks, running app",
                "status":"completed",
                "created_at":"2024-11-05T11:42:53",
                "completed_at":"2024-11-05T11:43:41",
                "result_bucket":"your.bucket.name",
                "result_file_path":"running_profiling",
                "line_count": 1209478,
                "fail_message":null
            },
            ...
        ]
    

    Failure

    For examples of responses in the event of a failed call, see Response status codes.


    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.