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

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

get

HTTPcURLJavaScriptPython

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
}

Retrieve user label

get

Get user label.

API key must have the View Eng Intelligence permission.

Authorizations

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

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"
  ]
}

Update user label assignments

post

Assign user label values to user emails in bulk.

API key must have the Edit user labels permission.

Authorizations

Body

Responses

post

HTTPcURLJavaScriptPython

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                \"[e-mail]\": [\n                    {\"id\": \"ul2da8159dbeefb974\", \"name\": \"Coding Language\", \"value\": \"Java\"},\n                    {\"id\": \"ul2da8159234bsdfas\", \"name\": \"Engineering Level\", \"value\": \"Senior\"}\n                ],\n                \"[e-mail]\": [\n                    {\"id\": \"ul2da8159dbeefb974\", \"name\": \"Coding Language\", \"value\": \"Typescript\"},\n                ]\n            }\n        "
}

{
  "userLabelAssignments": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "id": "text",
        "name": "text",
        "value": "text"
      }
    ]
  }
}