Reports

perception-attributes

orc perception-attributes manages observed and custom brand attributes. Add attributes for future observations, rename display labels, or hide attributes from reports and source evidence.

Supply a brand ID in the target Workspace. IDs returned for observed attributes by list can be used directly for update or delete. Renaming or hiding retains historical observations and the original source_label.

Usage

terminal
orc perception-attributes list --brand-id <brand-id>

Retrieve brand attributes.

Subcommands

list

List observed and custom attributes. An unavailable target brand returns 404.

terminal
orc perception-attributes list [options]

Unique options

--brand-id

Brand identifier in the selected workspace. Required; an unavailable brand returns 404.

Type: string. Required.

terminal
orc perception-attributes list --brand-id <value>

create

Create up to 10 active custom attributes per brand. Labels must contain 2–80 characters after Unicode NFKC normalization, trimming, and collapsing whitespace. Use an idempotency key for retries.

terminal
orc perception-attributes create [options]

Unique options

--idempotency-key

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

Type: string. Optional.

terminal
orc perception-attributes create --idempotency-key <value>
--brand-id

(required) Required brand in the selected workspace. Whitespace is trimmed.

Type: string. Optional.

terminal
orc perception-attributes create --brand-id <value>
--label

(required) Display label after Unicode NFKC normalization, trimming and whitespace collapsing. Must contain 2–80 characters after normalization.; max 80 chars

Type: string. Optional.

terminal
orc perception-attributes create --label <value>

update

Rename a persisted or observed attribute. Label normalization and the 2–80 character requirement match creation. Original source labels and existing evidence associations remain intact.

terminal
orc perception-attributes update <id> [options]

Unique options

--brand-id

(required) Required brand in the selected workspace. Whitespace is trimmed.

Type: string. Optional.

terminal
orc perception-attributes update <id> --brand-id <value>
--label

(required) Display label after Unicode NFKC normalization, trimming and whitespace collapsing. Must contain 2–80 characters after normalization.; max 80 chars

Type: string. Optional.

terminal
orc perception-attributes update <id> --label <value>

delete

Hide an attribute from reports and source evidence. Historical observations and source labels remain. Pass --yes to skip confirmation non-interactively.

terminal
orc perception-attributes delete <id> [options]

Unique options

--brand-id

Brand identifier in the selected workspace. Required; an unavailable brand returns 404.

Type: string. Required.

terminal
orc perception-attributes delete <id> --brand-id <value>

Examples

Add a custom attribute.

terminal
orc perception-attributes create --brand-id <brand-id> --label "Customer support"

Add a custom attribute.

Rename the display label.

terminal
orc perception-attributes update <attribute-id> --brand-id <brand-id> --label "Support quality"

Rename the display label.

Permissions

Authenticate and select the target Workspace. Access to that Workspace is required.

Global Options

The following global options can be used with orc perception-attributes:

For details and examples, see global options.