Eng Intel: User Labels
Use these operations to interact with user labels in Cortex Eng Intelligence.
Required permissions
Your API key must have the Configure user labels
permission.
Operations
Retrieves a list of all available user labels.
API key must have the View Eng Intelligence
permission.
Authorizations
Query parameters
pageSizeinteger · int32RequiredDefault:
Number of results to return per page, between 1 and 1000. Default 250.
250
pageinteger · int32RequiredDefault:
Page number to return, 0-indexed. Default 0.
0
Responses
200
Successfully retrieved user labels
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/eng-intel/labels HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"labels": [
{
"description": "text",
"id": "ul2da8159dbeefb974",
"name": "text",
"values": [
"text"
]
}
],
"page": 1,
"total": 1,
"totalPages": 1
}
Get user label.
API key must have the View Eng Intelligence
permission.
Authorizations
Path parameters
idstringRequired
Responses
200
Successfully retrieved user label
application/json
404
User label not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/eng-intel/labels/{id} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"description": "text",
"id": "ul2da8159dbeefb974",
"name": "text",
"values": [
"text"
]
}
Assign user label values to user emails in bulk.
API key must have the Edit user labels
permission.
Authorizations
Body
Responses
200
Successfully updated user label assignments
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
post
POST /api/v1/eng-intel/labels/users HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 522
{
"userLabelAssignments": "\n {\n \"[email protected]\": [\n {\"id\": \"ul2da8159dbeefb974\", \"name\": \"Coding Language\", \"value\": \"Java\"},\n {\"id\": \"ul2da8159234bsdfas\", \"name\": \"Engineering Level\", \"value\": \"Senior\"}\n ],\n \"[email protected]\": [\n {\"id\": \"ul2da8159dbeefb974\", \"name\": \"Coding Language\", \"value\": \"Typescript\"},\n ]\n }\n "
}
{
"userLabelAssignments": {
"ANY_ADDITIONAL_PROPERTY": [
{
"id": "text",
"name": "text",
"value": "text"
}
]
}
}
Last updated
Was this helpful?