Skip to main content

Get User Labels

GET /users/{user_id}/labels

Get a collection of labels and their weights used in recommendations for the given user. The higher weight values indicate higher user engagement. Results are order by highest-lowest weight values.

Request Parameters

Path Parameters

NameTypeDescription
user_id requiredstring

Header Parameters

NameTypeDescription
program-id requiredstring

Responses

200 Successful Response

UserLabelDict | application/json

NameTypeProperties
labels requiredobject

description: An array of key-value pairs containing label:weight

Response Example

{
"labels": "object"
}

404 User not found

ErrorMessage | application/json

NameTypeProperties
detail requiredstring

422 Validation Error

HTTPValidationError | application/json

NameTypeProperties
detailarray

items: {'$ref': '#/components/schemas/ValidationError'}

ValidationError | application/json

NameTypeProperties
loc requiredarray

items: {'anyOf': [{'type': 'string'}, {'type': 'integer'}]}

msg requiredstring
type requiredstring