Get collection stats

GET 
/api/v1/collections/:collection-id/stats

Get collection statistics for a given collection.

Request

Path Parameters

collection-id stringrequired

Collection ID

Responses

200

Successful response

application/json

Schema

Schema

result

object

required

users numberrequired

Number of users in the collection

chunks_count numberrequired

Number of chunks in the collection

characters numberrequired

data_stats

object[]

required

Aggregated statistics for the files in the collection, grouped by status.

Array [

status stringrequired

Possible values: [pending, indexed, error]

Status of the files

files numberrequired

Number of files in this status

bytes numbernullable

Storage size, in bytes, of the files in this status.

]

Example (from schema)

{
  "result": {
    "users": 0,
    "chunks_count": 0,
    "characters": 0,
    "data_stats": [
      {
        "status": "pending",
        "files": 0,
        "bytes": 0
      }
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

403

Forbidden

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

Not found

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

Loading...