Skip to content

workspaces_stats_retrieve

GET
/api/workspaces/{id}/stats
curl --request GET \
--url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stats \
--header 'Authorization: Bearer <token>'

Return the statistics of the data of a workspace.

The owner of the workspace sees all its data; any other member sees the data linked to the nodes they belong to. A data object linked to several nodes is counted once in every total.

id
required
string format: uuid

A UUID string identifying this workspace.

Media typeapplication/json

Statistics of the data of a workspace that the user may see.

object
data_count
required
integer
sized_data_count
required

Number of data whose size is known: the volume covers these only.

integer
total_size
required

Volume in octets.

integer
node_count
required
integer
source_count
required
integer
sources
required
Array<object>

The data held by the connections of one plugin.

object
data_count
required
integer
sized_data_count
required

Number of data whose size is known: the volume covers these only.

integer
total_size
required

Volume in octets.

integer
plugin
required
string
name
required
string
logo
required
string format: uri
nullable
connections
required
Array<object>

The data held by one connection.

object
data_count
required
integer
sized_data_count
required

Number of data whose size is known: the volume covers these only.

integer
total_size
required

Volume in octets.

integer
id
required
string format: uuid
name
required
string
nullable
file_types
required
Array<object>

The data of one file extension, or of one kind when they have none.

object
data_count
required
integer
sized_data_count
required

Number of data whose size is known: the volume covers these only.

integer
total_size
required

Volume in octets.

integer
extension
required
string
nullable
type
required
string
nullable
nodes
required
Array<object>

The data linked to a node or to any of its descendants, each counted once.

object
data_count
required
integer
sized_data_count
required

Number of data whose size is known: the volume covers these only.

integer
total_size
required

Volume in octets.

integer
id
required
string format: uuid
parent
required

Null when the node is a root, or when its parent is not visible.

string format: uuid
nullable
title
required
string
nullable
icon
required
string
nullable
shared
required

Some data are linked to several children of the node, or to the node and a child: the totals of the children add up to more than its own.

boolean
timeline
required
Array<object>

The data added to madbot on one day.

object
date
required
string format: date
data_count
required
integer
cumulative_count
required
integer

Example generated

{
"data_count": 1,
"sized_data_count": 1,
"total_size": 1,
"node_count": 1,
"source_count": 1,
"sources": [
{
"data_count": 1,
"sized_data_count": 1,
"total_size": 1,
"plugin": "example",
"name": "example",
"logo": "https://example.com",
"connections": [
{
"data_count": 1,
"sized_data_count": 1,
"total_size": 1,
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example"
}
]
}
],
"file_types": [
{
"data_count": 1,
"sized_data_count": 1,
"total_size": 1,
"extension": "example",
"type": "example"
}
],
"nodes": [
{
"data_count": 1,
"sized_data_count": 1,
"total_size": 1,
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"parent": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"title": "example",
"icon": "example",
"shared": true
}
],
"timeline": [
{
"date": "2026-04-15",
"data_count": 1,
"cumulative_count": 1
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "forbidden",
"message": "You do not have permission to perform this operation. Check the `details` property for more details.",
"details": [
{
"parameter": "workspace",
"code": "not_allowed",
"message": "You are not a member of this workspace."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "object_not_found",
"message": "Object not found. Check the `details` property for more details.",
"details": [
{
"parameter": "<id>",
"code": "does_not_exist",
"message": "\"<id>\" does not exist."
}
]
}