c8y(1)

📦 version 2.56.1, in nixpkgs unstable

🌸 c8y(1) — the manual page for c8y-tenantstatistics-listSummaryForTenant 💅

Okay bestie, listen up, because this manual page is literally about getting your tenant's whole usage vibe check. It's giving "commands that actually matter" and I'm obsessed. No cap. 🫶

✨ NAME ✨

c8y-tenantstatistics-listSummaryForTenant — Get tenant usage summary statistics

Like, it's the whole point of the command. You want the stats? This is the one. Periodt.

🦋 SYNOPSIS 🦋

c8y tenantstatistics listSummaryForTenant [flags]

Keep that exactly as it is, bestie, because commands are ✨iconic✨ and we don't mess with them.

🌈 DESCRIPTION 🌈

So the tea is: this command gets you a summary of requests and database usage from the start of this month until now. It's a little snapshot of your tenant's activity, and honestly? Super useful. Not me checking my stats every five minutes like a main character. 💀

💖 OPTIONS 💖

Alright, let's go through these one by one. Each one slays in its own way.

  • --dateFrom="" — Where the stats should start. Can be a date, or a date-and-time situation. Default is empty string.
  • --dateTo="" — Where the stats should end. Again, date or date-and-time. Default is empty string.
  • -h, --help[=false] — The classic help flag. Shows you the help for listSummaryForTenant. Default false, obviously.

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

These are the ones you get from the parent command — like when your older sibling lets you borrow their clothes. So many options, but we're going to go through every single one because that's how we do.

  • --abortOnErrors=10 — Aborts the batch when you hit this number of errors. Default is 10.
  • --allowEmptyPipe[=false] — Don't fail when piped input is empty (stdin). Default false.
  • --cache[=false] — Enables cached responses. Default false.
  • --cacheBodyPaths=[] — Cache should limit hashing to the selected paths in the JSON body. Empty means all values. Default is [].
  • --cacheTTL="60s" — Cache time-to-live (TTL) as a duration, like 60s or 2m. Default is "60s".
  • -c, --compact[=false] — Compact instead of pretty-printed output when using JSON output. Pretty print is the default if the output is the terminal. Default false.
  • --confirm[=false] — Prompts for confirmation. Default false.
  • --confirmText="" — Custom confirmation text. Default empty string.
  • --currentPage=0 — The current page that should be returned. Default 0.
  • --customQueryParam=[] — Adds custom URL query parameters, i.e. --customQueryParam 'withCustomOption=true,myOtherOption=myvalue'. Default [].
  • --debug[=false] — Sets very verbose log messages. Default false.
  • --delay="0ms" — Delay after each request, i.e. 5ms, 1.2s. Default "0ms".
  • --delayBefore="0ms" — Delay before each request, i.e. 5ms, 1.2s. Default "0ms".
  • --dry[=false] — Dry run. Doesn't send any data to the server. Default false.
  • --dryFormat="markdown" — Dry run output format, i.e. json, dump, markdown or curl. Default "markdown".
  • --examples[=false] — Shows examples for the current command. Default false.
  • --filter=[] — Applies a client-side filter to the response before returning it to the user. Default [].
  • --flatten[=false] — Flattens JSON output by replacing nested JSON properties with properties where their names are represented by dot notation. Default false.
  • -f, --force[=false] — Does not prompt for confirmation. Ignored when using --confirm. Default false.
  • -H, --header=[] — Custom headers, i.e. --header "Accept: value, AnotherHeader: myvalue". Default [].
  • --includeAll[=false] — Includes all results by iterating through each page. Default false.
  • -k, --insecure[=false] — Allows insecure server connections when using SSL. Default false.
  • -l, --logMessage="" — Adds a custom message to the activity log. Default empty string.
  • --maxJobs=0 — Maximum number of jobs. 0 means unlimited (use with caution!). Default 0. > ⚠️ Use with caution, bestie — unlimited jobs can get wild.
  • --noAccept[=false] — Ignores the Accept header, which removes the Accept header from requests. However, PUT and POST requests will only see the effect. Default false.
  • --noCache[=false] — Forces disabling of cached responses (overwrites the cache setting). Default false.
  • -M, --noColor[=false] — Don't use colors when displaying log entries on the console. Default false.
  • --noLog[=false] — Disables the activity log for the current command. Default false.
  • --noProgress[=false] — Disables progress bars. Default false.
  • --noProxy[=false] — Ignores the proxy settings. Default false.
  • -n, --nullInput[=false] — Don't read the input (stdin). Useful if you're using it in a shell for/while loop. Default false.
  • -o, --output="table" — Output format, i.e. table, json, csv, csvheader. Default is "table".
  • --outputFile="" — Saves JSON output to file (after select/view). Default empty string.
  • --outputFileRaw="" — Saves the raw response to file (before select/view). Default empty string.
  • --outputTemplate="" — Jsonnet template to apply to the output. Default empty string.
  • -p, --pageSize=5 — Maximum results per page. Default 5.
  • --progress[=false] — Shows progress bar. This will also disable any other verbose output. Default false.
  • --proxy="" — Proxy setting, i.e. http://10.0.0.1:8080. Default empty string.
  • -r, --raw[=false] — Shows raw response. This mode will force output=json and view=off. Default false.
  • --retries=3 — Max number of attempts when a failed HTTP call is encountered. Default 3.
  • --select=[] — Comma separated list of properties to return. Wildcards and globstar accepted, i.e. --select 'id,name,type,**.serialNumber'. Default [].
  • --session="" — Session configuration. Default empty string.
  • --sessionMode="" — Overrides the default session mode for a single command, which would normally be disabled. Default empty string.
  • -P, --sessionPassword="" — Override session password. Default empty string.
  • -U, --sessionUsername="" — Override session username, i.e. peter or t1234/peter (with tenant). Default empty string.
  • --silentExit[=false] — Silent status codes do not affect the exit code. Default false.
  • --silentStatusCodes="" — Status codes which will not print out an error message. Default empty string.
  • --timeout="600s" — Request timeout duration, i.e. 60s, 2m. Default "600s".
  • --totalPages=0 — Total number of pages to get. Default 0.
  • -v, --verbose[=false] — Verbose logging. Default false.
  • --view="auto" — Use views when displaying data on the terminal. Disable using --view off. Default "auto".
  • --withError[=false] — Errors will be printed on stdout instead of stderr. Default false.
  • --withTotalElements[=false] — Requests Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13). Default false.
  • -t, --withTotalPages[=false] — Requests Cumulocity to include the total pages in the response statistics under .statistics.totalPages. Default false.
  • --workers=1 — Number of workers. Default 1.

🎀 EXAMPLE 🎀

Like, examples are the best part because they show you exactly how to use it. Obsessed.

$ c8y tenantstatistics listSummaryForTenant

Get tenant summary statistics for the current tenant. Classic.

$ c8y tenantstatistics listSummaryForTenant --dateFrom "-30d"

Get tenant summary statistics collection for the last 30 days. Slay.

$ c8y tenantstatistics listSummaryForTenant --dateFrom "-10d" --dateTo "-9d"

Get tenant summary statistics collection for the last 10 days, only return until the last 9 days. Highkey specific, but we love that.

🌟 SEE ALSO 🌟

🫶 CUTE SIGN-OFF 🫶

So yeah, this manual page is from Jan 1980 (literally forever ago, but it's giving vintage) and it's part of the c8y(1) manual. Go forth and check those tenant stats, bestie. Iykyk. 💅✨

📦 where this page comes from