ulams stats

Generated from front/cli (ulams schema)

`ulams stats available`

Get list of available stats for models.

Kind: read (idempotent). Stability: stable. MCP tool: stats_available. Scopes: reports:read.

Endpoints: GET /api/admin/stats/available.

# Get list of available stats for models
ulams stats available --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}

`ulams stats cart`

Calculate stats for Cart.

Kind: read (idempotent). Stability: stable. MCP tool: stats_cart. Scopes: reports:read.

Endpoints: GET /api/admin/stats/cart.

Flag	Type	Required	Description
`--stats`	array		array of stats to be calculated, leave empty to calculate all available stats

# Calculate stats for Cart
ulams stats cart --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "stats": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array of stats to be calculated, leave empty to calculate all available stats"
    }
  },
  "additionalProperties": {}
}

`ulams stats course`

Calculate stats for Course.

Kind: read (idempotent). Stability: stable. MCP tool: stats_course. Scopes: reports:read.

Endpoints: GET /api/admin/stats/course/{course_id}.

Flag	Type	Required	Description
`--course-id` (positional)	integer	yes	Course ID
`--stats`	array		array of stats to be calculated, leave empty to calculate all available stats

# Calculate stats for Course
ulams stats course 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "course_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Course ID"
    },
    "stats": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array of stats to be calculated, leave empty to calculate all available stats"
    }
  },
  "required": [
    "course_id"
  ],
  "additionalProperties": {}
}

`ulams stats course-export`

Export stat for Course.

Kind: read (idempotent). Stability: stable. MCP tool: stats_course_export. Scopes: reports:read.

Endpoints: GET /api/admin/stats/course/{course_id}/export.

Flag	Type	Required	Description
`--course-id` (positional)	integer	yes	Course ID
`--stat`	string	yes
`--out`	string		Write the download to this path (- for stdout)

# Export stat for Course
ulams stats course-export 1 --stat text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "course_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Course ID"
    },
    "stat": {
      "type": "string"
    },
    "out": {
      "description": "Write the download to this path (- for stdout)",
      "type": "string"
    }
  },
  "required": [
    "course_id",
    "stat"
  ],
  "additionalProperties": {}
}

`ulams stats date-range`

Calculate stats for Course.

Kind: read (idempotent). Stability: stable. MCP tool: stats_date_range. Scopes: reports:read.

Endpoints: GET /api/admin/stats/date-range.

Flag	Type	Required	Description
`--stats`	array		array of stats to be calculated, leave empty to calculate all available stats

# Calculate stats for Course
ulams stats date-range --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "stats": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array of stats to be calculated, leave empty to calculate all available stats"
    }
  },
  "additionalProperties": {}
}

`ulams stats topic`

Calculate stats for Topic.

Kind: read (idempotent). Stability: stable. MCP tool: stats_topic. Scopes: reports:read.

Endpoints: GET /api/admin/stats/topic/{topic_id}.

Flag	Type	Required	Description
`--topic-id` (positional)	integer	yes	Topic ID
`--stats[]`	array		array of stats to be calculated, leave empty to calculate all available stats

# Calculate stats for Topic
ulams stats topic 1 --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "topic_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Topic ID"
    },
    "stats[]": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array of stats to be calculated, leave empty to calculate all available stats"
    }
  },
  "required": [
    "topic_id"
  ],
  "additionalProperties": {}
}

`ulams stats topic-export`

Export stat for Topic.

Kind: read (idempotent). Stability: stable. MCP tool: stats_topic_export. Scopes: reports:read.

Endpoints: GET /api/admin/stats/topic/{topic_id}/export.

Flag	Type	Required	Description
`--topic-id` (positional)	integer	yes	Topic ID
`--stat`	string	yes
`--out`	string		Write the download to this path (- for stdout)

# Export stat for Topic
ulams stats topic-export 1 --stat text --json

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "topic_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "Topic ID"
    },
    "stat": {
      "type": "string"
    },
    "out": {
      "description": "Write the download to this path (- for stdout)",
      "type": "string"
    }
  },
  "required": [
    "topic_id",
    "stat"
  ],
  "additionalProperties": {}
}