Graph Info

Database Information

get/v1/graphs/{graph_id}/info

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/info
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Response

Successful Response

graph_idstring required

Graph database identifier

database_namestring required

Database name

database_size_bytesinteger required

Database size in bytes

database_size_mbnumber required

Database size in MB

node_countinteger required

Total number of nodes

relationship_countinteger required

Total number of relationships

node_labelsstring[] required

List of node labels

relationship_typesstring[] required

List of relationship types

created_atstring required

Database creation timestamp

last_modifiedstring required

Last modification timestamp

schema_versionstring nullable

Schema version

read_onlyboolean required

Whether database is read-only

backup_countinteger required

Number of available backups

last_backup_datestring nullable

Date of last backup

Example response

{
  "graph_id": "kg1a2b3c4d5",
  "database_name": "kg1a2b3c4d5",
  "database_size_bytes": 1048576,
  "database_size_mb": 1,
  "node_count": 1250,
  "relationship_count": 2340,
  "node_labels": [
    "Entity",
    "Report",
    "Fact"
  ],
  "relationship_types": [
    "HAS_REPORT",
    "REPORTED_IN",
    "HAS_ELEMENT"
  ],
  "created_at": "2024-01-15T10:00:00Z",
  "last_modified": "2024-01-15T10:30:00Z",
  "schema_version": "1.0.0",
  "backup_count": 5,
  "last_backup_date": "2024-01-15T09:00:00Z"
}

Changes

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