Skip to main content
POST
Create label

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
entityType
string
required

Type of the entity to label

entityID
string
required

ID of the entity to label. Use app-<number> for applications, dec-<number> for decisions and decision options, and dva-<number> for decision variants.

option
string

Sub-key within the labeled entity. Required for entityType='decisionOption', must be empty (or omitted) for all other entity types.

displayName
string

Human-readable display name

description
string

Description of the entity

Response

Label created.

id
string
required

Label ID (format lbl-<number>).

entityType
string
required

Type of the labeled entity.

entityID
string
required

ID of the labeled entity. Applications use app-<number>, decisions use dec-<number>, decision variants use dva-<number>, and decision options use the parent decision ID dec-<number>.

option
string
required

Sub-key within the labeled entity. Only used for entityType='decisionOption' where entityID references the decision and option holds the option name (e.g. "social-google"). Empty string for all other entity types.

createdMs
integer<int64>
required

Creation time in milliseconds since epoch.

updatedMs
integer<int64>
required

Last update time in milliseconds since epoch.

displayName
string

Human-readable display name.

description
string

Description of the entity.