Skip to main content
On this page

Kater CLI Projects and timelines project metric

kater project metric add

Add figures of one query to a project, in one commit.

Show the change to the person and make it only after they say yes. Propose --better and --alert from the goal and the figures’ weeks: Track it in Kater proposes them the same way. The first figure of a project is the goal’s. A figure the project tracks already writes nothing.

Examples

Terminal window
# Add figures of one query to a project, in one commit
kater project metric add <project> <query> --figure <figure> --why <why>

Arguments

ArgumentDescription
<project>The project’s id.
<query>The query whose figures to track, its workspace path and name, such as …/workspaces/channel_performance_weekly/roas_trend_by_platform.

Options

OptionDescription
--figure <figure>Required. A figure to track, as <field>[:<row key>], such as platform_roas:TikTok Ads. Give it once for each figure. You can give it more than one time.
--label <text>The field as people read it, such as ROAS. Each figure reads it after its row key, such as TikTok Ads ROAS. Left out, the field’s name.
--better <better>Which way is good for each figure: higher, lower, or none for a figure that should only stay in its range. The default is none.
--alert <alert>When to say so for each figure: below:2.2, above:5000, change:20 (a percent), or none for outside its normal range.
--everyTrack every figure of the query: Kater also adds each new row of it as it arrives.
--why <why>Required. Why the project tracks them, which the timeline shows on its settings row.

It also takes the global options --json and --help.

See also