codespar meters
Meters: define one on a usage event, read its usage, its events and the cycle
Meters: define one on a usage event, read its usage, its events and the cycle
6 commands in @codespar/cli 0.18.1.
Each one prints what its operation answered. What a command prints has the rule, and Configuration has the exit codes and the shape of a failure.
codespar meters list
List the project's meters with their cycle figures
codespar meters list| option | what it does |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) (default: []) |
--timeout <ms> | Per-request timeout in milliseconds |
GET /v1/meters · parameters, responses and refusals
codespar meters create
Define a meter on a usage event
codespar meters create --input '{"event_name":"Example","aggregation":"count","price":0,"per_units":1,"unit_label":"Example","description":"string","channel":"invoice"}'| option | what it does |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) (default: []) |
--timeout <ms> | Per-request timeout in milliseconds |
-i, --input <json> | Request body as a JSON string |
-f, --input-file <path> | Request body from a JSON file |
POST /v1/meters · parameters, responses and refusals
codespar meters cycle
The meter cycle: progress, totals and totals by channel
codespar meters cycle| option | what it does |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) (default: []) |
--timeout <ms> | Per-request timeout in milliseconds |
GET /v1/meters/cycle · parameters, responses and refusals
codespar meters get
Read one meter with its cycle figures
codespar meters get meter_0000000000000000| argument | what it is |
|---|---|
<meterId> | String. |
| option | what it does |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) (default: []) |
--timeout <ms> | Per-request timeout in milliseconds |
GET /v1/meters/{meterId} · parameters, responses and refusals
codespar meters usage
A meter's usage on each day of the cycle
codespar meters usage meter_0000000000000000| argument | what it is |
|---|---|
<meterId> | String. |
| option | what it does |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) (default: []) |
--timeout <ms> | Per-request timeout in milliseconds |
GET /v1/meters/{meterId}/usage · parameters, responses and refusals
codespar meters events
A meter's latest events
codespar meters events meter_0000000000000000| argument | what it is |
|---|---|
<meterId> | String. |
| option | what it does |
|---|---|
-q, --query <key=value> | Query parameter (repeatable) (default: []) |
--timeout <ms> | Per-request timeout in milliseconds |
GET /v1/meters/{meterId}/events · parameters, responses and refusals