Skip to main content

Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:
  • --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
  • --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. name, not --name).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

list

List charts Retrieve all charts in the current scope.

Usage

honeyhive charts list

create

Create a new chart

Usage

honeyhive charts create [options]

Options

FlagTypeRequiredDescription
--metricstringyesName of the metric to visualize
--namestringyesDisplay name for the chart
--bucketingstringnoTime bucket granularity for aggregation Allowed: minute, hour, day, week, month.
--date-rangejsonnoTime range to query
--descriptionstringnoDescription of what the chart shows
--funcstringnoAggregation function to apply (e.g. sum, avg, median, min, max)
--group-bystringnoField to group results by
--owner-idstringnoID of the user who owns this chart
--queryjsonnoFilters to apply to the chart data
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

get

Get a chart Retrieve a single chart by id.

Usage

honeyhive charts get [options]

Options

FlagTypeRequiredDescription
--chart-idstringyesThe unique identifier of the chart to retrieve
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

update

Update a chart Update a chart’s editable fields. Only fields included in the request body are modified.

Usage

honeyhive charts update [options]

Options

FlagTypeRequiredDescription
--chart-idstringyesThe unique identifier of the chart to update
--bucketingstringnoTime bucket granularity for aggregation Allowed: minute, hour, day, week, month.
--date-rangejsonnoTime range to query
--descriptionstringnoDescription of what the chart shows
--funcstringnoAggregation function to apply (e.g. sum, avg, median, min, max)
--group-bystringnoField to group results by
--metricstringnoName of the metric to visualize
--namestringnoDisplay name for the chart
--owner-idstringnoID of the user who owns this chart
--queryjsonnoFilters to apply to the chart data
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

delete

Delete a chart

Usage

honeyhive charts delete [options]

Options

FlagTypeRequiredDescription
--chart-idstringyesThe unique identifier of the chart to delete
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.