Skip to content

ulams reports

Generated from front/cli (ulams schema)

Get list of available metrics for logged user.

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

Endpoints: GET /api/admin/reports/available-for-user.

Terminal window
# Get list of available metrics for logged user
ulams reports available-for-user --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}

Get list of available metrics.

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

Endpoints: GET /api/admin/reports/metrics.

Terminal window
# Get list of available metrics
ulams reports metrics --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}

Get list of available metrics.

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

Endpoints: GET /api/admin/reports/report.

Flag Type Required Description
--metric string yes one of available metrics
--date string date from which report should be loaded (if there exists historical data), limit will be ignored and only datapoints with which record was created will be loaded; don’t send this param to always get fresh report; send today date if you want to get latest stored report
--limit integer how many datapoints should be returned. To get all datapoints set limit as -1
Terminal window
# Get list of available metrics
ulams reports report --metric text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"metric": {
"type": "string",
"description": "one of available metrics"
},
"date": {
"type": "string",
"description": "date from which report should be loaded (if there exists historical data), limit will be ignored and only datapoints with which record was created will be loaded; don't send this param to always get fresh report; send today date if you want to get latest stored report"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "how many datapoints should be returned. To get all datapoints set limit as -1"
}
},
"required": [
"metric"
],
"additionalProperties": {}
}