OpenapiO11y
Returns one preference of the calling user, by name.
Returns one preference of the calling user, by name.
GET /v1/o11y/user/preferences/{name}
| Address | https://api.hanzo.ai/v1/o11y/user/preferences/{name} |
| Method | GET |
| Operation | GetUserPreference |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one preference of the calling user, by name. Viewer gate.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yPreferenceOut | ok |
200 body — 9 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yPreference | — | |
data.allowedScopes | body | string[] | — | AllowedScopes are the scopes the preference may be set at — org, user. |
data.allowedValues | body | string[] | — | AllowedValues restricts a string preference to these values. |
data.defaultValue | body | object | — | DefaultValue is the value before anyone set one. |
data.description | body | string | — | Description says what the preference does. |
data.name | body | string | — | Name is the preference name. |
data.value | body | object | — | Value is the current value. |
data.valueType | body | string | — | ValueType is the JSON type a value must have — string, integer, float or boolean. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y user preferences get <name>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getUserPreference({ name: 'name' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).get_user_preference(name='name')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.GetUserPreference(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, o11y_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = o11y_api::get_user_preference(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).getUserPreference();curl https://api.hanzo.ai/v1/o11y/user/preferences/<name> \
-H "Authorization: Bearer $HANZO_API_KEY"Tool o11y, op GetUserPreference — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "o11y",
"arguments": {
"op": "GetUserPreference",
"input": {
"name": "<name>"
}
}
}
}'How is this guide?