Alerts

Preview diff between imported semantic groups and current DB state

This endpoint compares the provided semantic groups with what's currently stored and returns a diff showing additions, modifications, and unchanged groups. The UI can use this to show users what will change before they commit.

post/api/{org_id}/alerts/deduplication/semantic-groups/preview-diff

Request

Base URL
https://api.openobserve.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/alerts/deduplication/semantic-groups/preview-diff/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

org_idstring required

Organization ID

Request body

displaystring required

Human-readable display name (e.g., "Host", "K8s Cluster")

fieldsstring[] required

List of field names that are equivalent (e.g., ["host", "hostname", "node"])

Note: Field names can overlap with other groups. First-defined group wins.

groupstring nullable

Category/group this semantic field belongs to (e.g., "Common", "Kubernetes", "AWS", "GCP", "Azure") Used for UI organization and preset templates

idstring required

Unique identifier (lowercase, dash-separated, e.g., "host", "k8s-cluster")

is_workload_typeboolean

When true, this alias is a workload-type dimension used to build identity sets. Aliases with this flag are grouped by their group field to form IdentitySet entries with distinguish_by populated from those alias IDs. Aliases without this flag (HTTP, Database, System, etc.) are never used as identity set discriminators.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.