Browse the API reference

Get Graph Metrics

get/v1/graphs/{graph_id}/metrics

Part of Usage.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/metrics" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
graph_idrequiredstring

Graph database identifier

graph_nameoptionalstring

Display name for the graph

user_roleoptionalstring

User's role in this graph

timestamprequiredstring

Metrics collection timestamp

total_nodesrequiredinteger

Total number of nodes

total_relationshipsrequiredinteger

Total number of relationships

node_countsrequiredobject

Node counts by label

relationship_countsrequiredobject

Relationship counts by type

storagerequiredobject

Measured on-disk storage: total_bytes/kb/mb/gb plus itemized `items` (graph, memory, subgraph, vectors, staging). Carries `error` instead if the instance could not be reached — the fields are absent rather than estimated.

health_statusrequiredobject

Database health information

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error