Get custom attributes list

Article summary

Did you find this summary helpful?

Thank you for your feedback

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:

Method	URI
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:

Field	Type	Required	Description
`index`	Integer	Optional	Start location of profile list Default: 0
`limit`	Integer	Optional	Profile 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:

Field	Type	Required	Description
`index`	Integer	-	Page index (0 - N)
`limit`	Integer	-	Profile list output limit value (1 - 100)
`total`	Integer	-	Total number of profiles created by the user
`profiles.profile_id`	String	-	Profile ID
`profiles.profile_name`	String	-	Profile name of the custom attributes entered by the user
`profiles.feature_id`	String	-	Feature ID to be profiled, enter when creating custom attributes
`profiles.feature_name`	String	-	Feature name to profile
`profiles.keyword_set`	String	-	A list of attribute keywords entered by the user (keywords to check similarity with the target user)
`profiles.status`	String	-	Creation type `registered` \| `pending` \| `in_progress` \| `completed` \| `failed` `registered`: registered `pending`: pending `in_progress`: creating `completed`: available `failed`: failed
`profiles.created_at`	String	-	Custom attributes creation request date (ISO 8601 format)
`profiles.completed_at`	String	-	Custom attributes creation completion date (ISO 8601 format)
`profiles.result_bucket`	String	-	Name of the Object Storage bucket to store custom attributes job results
`profiles.result_file_path`	String	-	File path to save the results in the result_bucket bucket
`profiles.line_count`	Integer	-	Number of lines of the feature used to create custom attributes
`profiles.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.

{
    "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?

What's Next

Create custom attributes

Table of contents

Request
Response