Find communities with label propagation

GET /v1/tenants/{tenant}/graph/{schema}/label_propagation

Group records through their neighborsCommunity labels identify groups rather than ranking them.

Choose the relationSet the iteration limit and random seed.
Propagate neighboring labelsGroup connected nodes through repeated label updates.
Read each node's labelMatching labels identify a detected community.

Before you start

Use your database bearer token.

Register the schema and relation, then add their rows. The examples use demo.people, its bidirectional follows relation, and linked rows u1, u2 and u3.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`schema`	`string`	Required

Query parameters

Field	Type	Required
`rel`	`string`	Required
`max_iter`	`integer`	Optional
`seed`	`integer`	Optional

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Nodes sharing a label belong to the same detected community. Labels identify groups; their numeric values do not rank the groups by importance.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
408	Reduce query work or adjust the timeout.
429	Honor Retry-After when present; back off.
499	The client cancelled the request.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/graph/demo.people/label_propagation?rel=follows&max_iter=20&seed=42" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

[
  {
    "pk": [
      "u1"
    ],
    "label": 0
  },
  {
    "pk": [
      "u2"
    ],
    "label": 0
  },
  {
    "pk": [
      "u3"
    ],
    "label": 0
  }
]

Illustrates one community; label values are algorithm-dependent.

Download the OpenAPI specification for the complete response schemas.

Find communities with label propagation

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link