c8y(1)

Bestie, welcome to the c8y(1) manual page — the Cumulocity CLI one. Today’s main character is c8y-tenantstatistics, aka Cumulocity tenant statistics, and she is serving REST endpoint energy. We’re gonna read every flag together, no skipping. 💅✨

🎀 NAME 🎀

c8y-tenantstatistics - Cumulocity tenant statistics. That’s the whole name, and she ate. 🍓

📜 SYNOPSIS 📜

c8y tenantstatistics [flags]

💖 DESCRIPTION 💖

This is the REST endpoint to interact with Cumulocity tenant statistics. Lowkey essential if tenant stats are your thing. 🦋

✨ OPTIONS ✨

Only one local option here, but she’s important:

• -h, --help[=false] — help for tenantstatistics 💖

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

These are inherited from the parent commands — hand-me-downs, but make it fashion. 😌

• --abortOnErrors=10 — aborts the batch when it reaches the specified number of errors 😭
• --allowEmptyPipe[=false] — don’t fail when the piped input (stdin) is empty 🫶
• --cache[=false] — enables cached responses 🧚
• --cacheBodyPaths=[] — lets the cache limit hashing to selected paths in the json body; empty means all values 🍓
• --cacheTTL="60s" — cache time-to-live (TTL) as a duration, like 60s or 2m ⭐
• -c, --compact[=false] — compacts output instead of pretty-printing when you’re using json output; pretty print is the default if output is the terminal 💅
• --confirm[=false] — prompts for confirmation 🙈
• --confirmText="" — custom confirmation text 🎀
• --currentPage=0 — current page which should be returned 📄
• --customQueryParam=[] — adds custom URL query parameters, like --customQueryParam 'withCustomOption=true,myOtherOption=myvalue' 🔥
• --debug[=false] — sets very verbose log messages 🫶
• --delay="0ms" — delay after each request, like 5ms or 1.2s ⏳
• --delayBefore="0ms" — delay before each request, like 5ms or 1.2s ⏳
• --dry[=false] — dry run — don’t send any data to the server 🌸
• --dryFormat="markdown" — dry run output format, like json, dump, markdown, or curl 💜
• --examples[=false] — shows examples for the current command ✨
• --filter=[] — applies a client-side filter to the response before returning it to you 🦋
• --flatten[=false] — flattens json output by replacing nested json properties with properties whose names use dot notation 🧚
• -f, --force[=false] — do not prompt for confirmation; ignored when using --confirm 💀
• -H, --header=[] — custom headers, like --header "Accept: value, AnotherHeader: myvalue" 👑
• --includeAll[=false] — includes all results by iterating through each page 🌈
• -k, --insecure[=false] — allows insecure server connections when using SSL 👀
• -l, --logMessage="" — adds a custom message to the activity log 📝
• --maxJobs=0 — maximum number of jobs; 0 = unlimited (use with caution!) 😭🔥
• --noAccept[=false] — ignores the Accept header by removing it from requests; however, PUT and POST requests will only see the effect 💅
• --noCache[=false] — force-disables cached responses (overwrites the cache setting) 🙅‍♀️
• -M, --noColor[=false] — don’t use colors when displaying log entries on the console 🎨
• --noLog[=false] — disables the activity log for the current command 🚫
• --noProgress[=false] — disables progress bars 📉
• --noProxy[=false] — ignores the proxy settings 🌐
• -n, --nullInput[=false] — don’t read input (stdin); useful if using in shell for/while loops 🌀
• -o, --output="table" — output format, like table, json, csv, csvheader 📊
• --outputFile="" — saves JSON output to a file (after select/view) 💾
• --outputFileRaw="" — saves the raw response to a file (before select/view) 🗂️
• --outputTemplate="" — jsonnet template to apply to the output 🧩
• -p, --pageSize=5 — maximum results per page 📚
• --progress[=false] — shows a progress bar; this also disables any other verbose output 📶
• --proxy="" — proxy setting, like http://10.0.0.1:8080 🛰️
• -r, --raw[=false] — shows the raw response; this mode forces output=json and view=off 🥩
• --retries=3 — max number of attempts when a failed http call is encountered 🔁
• --select=[] — comma-separated list of properties to return; wildcards and globstar accepted, like --select 'id,name,type,**.serialNumber' 🎯
• --session="" — session configuration 🔐
• --sessionMode="" — overrides the default session mode for a single command which would normally be disabled 🎛️
• -P, --sessionPassword="" — overrides the session password 🤫
• -U, --sessionUsername="" — overrides the session username, like peter or t1234/peter (with tenant) 🪪
• --silentExit[=false] — silent status codes do not affect the exit code 🤐
• --silentStatusCodes="" — status codes which will not print out an error message 🔇
• --timeout="600s" — request timeout duration, like 60s or 2m ⌛
• --totalPages=0 — total number of pages to get 📖
• -v, --verbose[=false] — verbose logging 🗣️
• --view="auto" — uses views when displaying data on the terminal; disable with --view off 👀
• --withError[=false] — errors will be printed on stdout instead of stderr 🚨
• --withTotalElements[=false] — asks Cumulocity to include the total elements in the response statistics under .statistics.totalElements (introduced in 10.13) 🧮
• -t, --withTotalPages[=false] — asks Cumulocity to include the total pages in the response statistics under .statistics.totalPages 📑
• --workers=1 — number of workers 👯‍♀️

🔗 SEE ALSO 🔗

• c8y(1)
• c8y-tenantstatistics-list(1)
• c8y-tenantstatistics-listSummaryAllTenants(1)
• c8y-tenantstatistics-listSummaryForTenant(1)

Signing off from the c8y(1) page, dated Jan 1980 — vintage manual energy, but make it current. Stay slay, bestie. 💖🦋👑