Measure node betweenness

Score nodes by how often they lie on shortest paths, using exact calculation or sampling.

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

Find nodes that bridge shortest routesSampling and node limits affect the reported scores.

Select the graph scopeChoose a relation and calculation limits.
Compare shortest routesMeasure how often each node lies between other nodes.
Read bridge scoresCompare nodes using the same calculation settings.

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_nodes`	`integer`	Optional
`samples`	`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.

Each row pairs a node key with its betweenness score. Scores describe its position in this graph and relation; sampling and node limits affect the calculation, so keep those settings consistent when comparing runs.

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/betweenness?rel=follows&max_nodes=100" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

[
  {
    "pk": [
      "u1"
    ],
    "betweenness": 1
  },
  {
    "pk": [
      "u2"
    ],
    "betweenness": 1
  },
  {
    "pk": [
      "u3"
    ],
    "betweenness": 1
  }
]

Illustrative centrality values; normalization and graph orientation determine exact scores.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Query parameters

Headers

Read the result

Response statuses