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

List user labels

get

Retrieves a list of all available user labels.

API key must have the View Eng Intelligence permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

Responses

200

Successfully retrieved user labels

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

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

/api/v1/eng-intel/labels

HTTPcURLJavaScriptPython

GET /api/v1/eng-intel/labels?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "labels": [
    {
      "description": "text",
      "id": "ul2da8159dbeefb974",
      "name": "text",
      "values": [
        "text"
      ]
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Retrieve user label

get

Get user label.

API key must have the View Eng Intelligence permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

idstringRequired

Responses

200

Successfully retrieved user label

application/json

descriptionstringOptional

Optional description of the user label

idstringRequired

Unique, immutable, 18-character auto-generated identifier for the user label.

Example: ul2da8159dbeefb974

namestringRequired

Unique name for the user label

valuesstring[]Required

Possible values for the user label

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

/api/v1/eng-intel/labels/{id}

HTTPcURLJavaScriptPython

GET /api/v1/eng-intel/labels/{id} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "description": "text",
  "id": "ul2da8159dbeefb974",
  "name": "text",
  "values": [
    "text"
  ]
}

Update user label assignments

post

Assign user label values to user emails in bulk.

API key must have the Edit user labels permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

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

/api/v1/eng-intel/labels/users

HTTPcURLJavaScriptPython

POST /api/v1/eng-intel/labels/users HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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"
      }
    ]
  }
}