Server usage statistics

In order to extract server usage statistics, the administrator needs to provide:

  • The Parsec Server address as a Parsec URL parsec3://hostname:port

  • The administration_token configured in the Parsec Server

  • The extraction date (ignores everything after the date provided)

  • The output filename

  • The output file format which can be CSV or JSON

parsec-cli server stats --addr=parsec3://example.com --token=s3cr3t --end-date=2024-08-31 --format=csv > 202408-my_server_stats.csv

Example of output:

{
  "stats": [
    {
      "active_users": 1,
      "data_size": 18333,
      "metadata_size": 1158,
      "organization_id": "JohnOrg",
      "realms": 2,
      "users": 1,
      "users_per_profile_detail": {
        "ADMIN": {
          "active": 1,
          "revoked": 0
        },
        "OUTSIDER": {
          "active": 0,
          "revoked": 0
        },
        "STANDARD": {
          "active": 0,
          "revoked": 0
        }
      }
    }
  ]
}