Get Graph Metrics
get
/v1/graphs/{graph_id}/metricsPart of Usage.
Authentication
Authenticate in any one of these ways — not all of them:
- API key in the
X-API-Keyheader. - Bearer token in the
Authorizationheader.
Path parameters
| Name | Type | Description |
|---|---|---|
graph_idrequired | string | Graph 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
| Field | Type | Description |
|---|---|---|
graph_idrequired | string | Graph database identifier |
graph_nameoptional | string | Display name for the graph |
user_roleoptional | string | User's role in this graph |
timestamprequired | string | Metrics collection timestamp |
total_nodesrequired | integer | Total number of nodes |
total_relationshipsrequired | integer | Total number of relationships |
node_countsrequired | object | Node counts by label |
relationship_countsrequired | object | Relationship counts by type |
storagerequired | object | 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_statusrequired | object | Database health information |
| Status | Meaning |
|---|---|
| 400 | Invalid request |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Resource not found |
| 422 | Validation Error |
| 429 | Rate limit exceeded |
| 500 | Internal server error |