checkly 7.5.5 → 7.6.0

package/oclif.manifest.json

@@ -987,6 +987,52 @@
           "multiple": false,
           "type": "option"
         },
+        "stats-range": {
+          "description": "Time range for stats.",
+          "name": "stats-range",
+          "default": "last24Hours",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "last24Hours",
+            "last7Days",
+            "last30Days",
+            "thisWeek",
+            "thisMonth",
+            "lastWeek",
+            "lastMonth"
+          ],
+          "type": "option"
+        },
+        "group-by": {
+          "description": "Group stats by dimension.",
+          "name": "group-by",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "location",
+            "statusCode"
+          ],
+          "type": "option"
+        },
+        "metrics": {
+          "description": "Comma-separated list of metrics to show (overrides defaults).",
+          "name": "metrics",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "filter-status": {
+          "description": "Only include runs with this status in stats.",
+          "name": "filter-status",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "success",
+            "failure"
+          ],
+          "type": "option"
+        },
         "output": {
           "char": "o",
           "description": "Output format.",
@@ -1071,12 +1117,12 @@
           "options": [
             "API",
             "BROWSER",
-            "MULTI_STEP",
             "HEARTBEAT",
+            "MULTI_STEP",
             "PLAYWRIGHT",
             "TCP",
-            "DNS",
             "ICMP",
+            "DNS",
             "URL"
           ],
           "type": "option"
@@ -1135,6 +1181,121 @@
         "list.js"
       ]
     },
+    "checks:stats": {
+      "aliases": [],
+      "args": {
+        "checkIds": {
+          "description": "One or more check IDs to get stats for.",
+          "name": "checkIds",
+          "required": false
+        }
+      },
+      "description": "Show analytics stats for your checks.",
+      "flags": {
+        "range": {
+          "char": "r",
+          "description": "Time range for stats.",
+          "name": "range",
+          "default": "last24Hours",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "last24Hours",
+            "last7Days",
+            "thisWeek",
+            "lastWeek",
+            "lastMonth"
+          ],
+          "type": "option"
+        },
+        "limit": {
+          "char": "l",
+          "description": "Number of checks to return (1-100).",
+          "name": "limit",
+          "default": 25,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page": {
+          "char": "p",
+          "description": "Page number.",
+          "name": "page",
+          "default": 1,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "tag": {
+          "char": "t",
+          "description": "Filter by tag. Can be specified multiple times.",
+          "name": "tag",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "search": {
+          "char": "s",
+          "description": "Filter checks by name (case-insensitive).",
+          "name": "search",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "description": "Filter by check type.",
+          "name": "type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "API",
+            "BROWSER",
+            "HEARTBEAT",
+            "MULTI_STEP",
+            "PLAYWRIGHT",
+            "TCP",
+            "ICMP",
+            "DNS",
+            "URL"
+          ],
+          "type": "option"
+        },
+        "output": {
+          "char": "o",
+          "description": "Output format.",
+          "name": "output",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "md"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": false,
+      "hiddenAliases": [],
+      "id": "checks:stats",
+      "pluginAlias": "checkly",
+      "pluginName": "checkly",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "coreCommand": false,
+      "readOnly": true,
+      "destructive": false,
+      "idempotent": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "checks",
+        "stats.js"
+      ]
+    },
     "debug:parse-file": {
       "aliases": [],
       "args": {},
@@ -1291,24 +1452,44 @@
         "parse-project.js"
       ]
     },
-    "import:apply": {
+    "env:add": {
       "aliases": [],
-      "args": {},
-      "description": "Attach imported resources into your project in a pending state.",
+      "args": {
+        "key": {
+          "description": "Environment variable key.",
+          "name": "key",
+          "required": true
+        },
+        "value": {
+          "description": "Environment variable value.",
+          "name": "value",
+          "required": false
+        }
+      },
+      "description": "Add environment variable via \"checkly env add <key> <value>\".",
       "flags": {
-        "config": {
-          "char": "c",
-          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
-          "name": "config",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "locked": {
+          "char": "l",
+          "description": "Indicate that the environment variable will be locked.",
+          "name": "locked",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "secret": {
+          "char": "s",
+          "description": "Indicate that the environment variable will be secret.",
+          "exclusive": [
+            "locked"
+          ],
+          "name": "secret",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "import:apply",
+      "id": "env:add",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
@@ -1322,168 +1503,118 @@
       "relativePath": [
         "dist",
         "commands",
-        "import",
-        "apply.js"
+        "env",
+        "add.js"
       ]
     },
-    "import:cancel": {
+    "env:ls": {
       "aliases": [],
       "args": {},
-      "description": "Cancels an ongoing import plan that has not been committed yet.",
-      "flags": {
-        "config": {
-          "char": "c",
-          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
-          "name": "config",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "all": {
-          "description": "Cancel all plans.",
-          "name": "all",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
+      "description": "List all Checkly environment variables via \"checkly env ls\".",
+      "flags": {},
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "import:cancel",
+      "id": "env:ls",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
       "coreCommand": false,
-      "readOnly": false,
+      "readOnly": true,
       "destructive": false,
       "idempotent": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "import",
-        "cancel.js"
+        "env",
+        "ls.js"
       ]
     },
-    "import:commit": {
+    "env:pull": {
       "aliases": [],
-      "args": {},
-      "description": "Permanently commit imported resources into your project.",
+      "args": {
+        "filename": {
+          "default": ".env",
+          "description": "Filename of the generated file.",
+          "name": "filename",
+          "required": false
+        }
+      },
+      "description": "Pull Checkly environment variables via \"checkly env pull <filename>\".",
       "flags": {
-        "config": {
-          "char": "c",
-          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
-          "name": "config",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "force": {
+          "char": "f",
+          "description": "Force to overwrite existing file.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "import:commit",
+      "id": "env:pull",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
       "coreCommand": false,
-      "readOnly": false,
+      "readOnly": true,
       "destructive": false,
-      "idempotent": false,
+      "idempotent": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "import",
-        "commit.js"
+        "env",
+        "pull.js"
       ]
     },
-    "import:plan": {
+    "env:rm": {
       "aliases": [],
       "args": {
-        "resource": {
-          "description": "A specific resource to import.",
-          "name": "resource",
-          "required": false
+        "key": {
+          "description": "Environment variable key to remove.",
+          "name": "key",
+          "required": true
         }
       },
-      "description": "Import existing resources from your Checkly account to your project.\n\nBy default, all resources that can be imported will be imported. However, you\nmay fine-tune the process by including or excluding any combination of\nresources.\n\nThe import process consists of three steps:\n\n1. Creating a plan, which generates the appropriate code for your resources\n2. Applying the plan, which links your resources to the generated code\n3. Committing the plan, which finalizes the import session\n\nCREATING A PLAN\n\nCreating a plan carries no risk as no concrete links to your Checkly resources\nare made at this point. However, if you accidentally deploy the generated code\nbefore applying the plan, you will end up with duplicate resources and will\nnot be able to complete the import session without first deleting the\nduplicates.\n\nFor the curious, you may also preview the generated code with the '--preview'\noption. No plan will be created, allowing you to leisurely inspect the\ngenerated code. However keep in mind that you will need to create a plan to\nactually import any resources, at which point the code will be generated\nagain.\n\nYou may cancel any plan you've created without affecting any of the\nunderlying resources.\n\nAPPLYING A PLAN\n\nApplying a plan links your existing resources to the generated code. You\nshould carefully review the generated code to make sure that it contains the\nresources you expect before applying a plan. After a plan has been applied,\nany deployments of those resources will irreversibly modify the underlying\nCheckly resources. However, as a fail safe against concurrent use, any\ndeployments not including the imported resources will not delete the\nunderlying resources (or the links to the resources). This means that there\nis no need to block deployments while working on an import session.\n\nEven after you've applied a plan, you may still cancel it, which will unlink\nthe underlying resources from your project once more. However, keep in mind\nthat any changes to the resources that you've already deployed cannot be\nundone.\n\nCOMMITTING A PLAN\n\nFinally, committing a plan removes all fail safes and permanently links the\nimported resources to your project. Any resources you remove from your code\nwill result in the underlying resources also getting irrevocably deleted on\nthe next deploy. You should only commit your plan once you are sure that all\nfuture deployments include the imported resources.",
+      "description": "Remove environment variable via \"checkly env rm <key>\".",
       "flags": {
-        "config": {
-          "char": "c",
-          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
-          "name": "config",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "root": {
-          "description": "The root folder in which to write generated code files.",
-          "name": "root",
-          "default": "__checks__",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "preview": {
-          "description": "Preview generated code without creating an actual import plan.",
-          "name": "preview",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "debug-import-plan": {
-          "description": "Output the import plan to a file.",
-          "hidden": true,
-          "name": "debug-import-plan",
+        "force": {
+          "char": "f",
+          "description": "Force to skip the confirmation prompt.",
+          "name": "force",
           "allowNo": false,
           "type": "boolean"
-        },
-        "debug-import-plan-input-file": {
-          "description": "A file to load an import plan from.",
-          "hidden": true,
-          "name": "debug-import-plan-input-file",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "debug-import-plan-output-file": {
-          "description": "The file to output the import plan to.",
-          "hidden": true,
-          "name": "debug-import-plan-output-file",
-          "default": "./debug-import-plan.json",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hidden": false,
-      "hiddenAliases": [
-        "import"
-      ],
-      "id": "import:plan",
+      "hiddenAliases": [],
+      "id": "env:rm",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
-      "strict": false,
+      "strict": true,
       "enableJsonFlag": false,
       "coreCommand": false,
-      "readOnly": true,
-      "destructive": false,
-      "idempotent": true,
+      "readOnly": false,
+      "destructive": true,
+      "idempotent": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "import",
-        "plan.js"
+        "env",
+        "rm.js"
       ]
     },
-    "env:add": {
+    "env:update": {
       "aliases": [],
       "args": {
         "key": {
@@ -1497,18 +1628,18 @@
           "required": false
         }
       },
-      "description": "Add environment variable via \"checkly env add <key> <value>\".",
+      "description": "Update environment variable via \"checkly env update <key> <value>\".",
       "flags": {
         "locked": {
           "char": "l",
-          "description": "Indicate that the environment variable will be locked.",
+          "description": "Indicate if environment variable is locked.",
           "name": "locked",
           "allowNo": false,
           "type": "boolean"
         },
         "secret": {
           "char": "s",
-          "description": "Indicate that the environment variable will be secret.",
+          "description": "Indicate if environment variable is secret.",
           "exclusive": [
             "locked"
           ],
@@ -1520,7 +1651,7 @@
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "env:add",
+      "id": "env:update",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
@@ -1529,57 +1660,66 @@
       "coreCommand": false,
       "readOnly": false,
       "destructive": false,
-      "idempotent": false,
+      "idempotent": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
         "env",
-        "add.js"
+        "update.js"
       ]
     },
-    "env:ls": {
+    "import:apply": {
       "aliases": [],
       "args": {},
-      "description": "List all Checkly environment variables via \"checkly env ls\".",
-      "flags": {},
+      "description": "Attach imported resources into your project in a pending state.",
+      "flags": {
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "env:ls",
+      "id": "import:apply",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
       "coreCommand": false,
-      "readOnly": true,
+      "readOnly": false,
       "destructive": false,
-      "idempotent": true,
+      "idempotent": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "env",
-        "ls.js"
+        "import",
+        "apply.js"
       ]
     },
-    "env:pull": {
+    "import:cancel": {
       "aliases": [],
-      "args": {
-        "filename": {
-          "default": ".env",
-          "description": "Filename of the generated file.",
-          "name": "filename",
-          "required": false
-        }
-      },
-      "description": "Pull Checkly environment variables via \"checkly env pull <filename>\".",
+      "args": {},
+      "description": "Cancels an ongoing import plan that has not been committed yet.",
       "flags": {
-        "force": {
-          "char": "f",
-          "description": "Force to overwrite existing file.",
-          "name": "force",
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "all": {
+          "description": "Cancel all plans.",
+          "name": "all",
           "allowNo": false,
           "type": "boolean"
         }
@@ -1587,47 +1727,42 @@
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "env:pull",
+      "id": "import:cancel",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
       "strict": true,
       "enableJsonFlag": false,
       "coreCommand": false,
-      "readOnly": true,
+      "readOnly": false,
       "destructive": false,
       "idempotent": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "env",
-        "pull.js"
+        "import",
+        "cancel.js"
       ]
     },
-    "env:rm": {
+    "import:commit": {
       "aliases": [],
-      "args": {
-        "key": {
-          "description": "Environment variable key to remove.",
-          "name": "key",
-          "required": true
-        }
-      },
-      "description": "Remove environment variable via \"checkly env rm <key>\".",
+      "args": {},
+      "description": "Permanently commit imported resources into your project.",
       "flags": {
-        "force": {
-          "char": "f",
-          "description": "Force to skip the confirmation prompt.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hidden": false,
       "hiddenAliases": [],
-      "id": "env:rm",
+      "id": "import:commit",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
@@ -1635,69 +1770,95 @@
       "enableJsonFlag": false,
       "coreCommand": false,
       "readOnly": false,
-      "destructive": true,
+      "destructive": false,
       "idempotent": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "env",
-        "rm.js"
+        "import",
+        "commit.js"
       ]
     },
-    "env:update": {
+    "import:plan": {
       "aliases": [],
       "args": {
-        "key": {
-          "description": "Environment variable key.",
-          "name": "key",
-          "required": true
-        },
-        "value": {
-          "description": "Environment variable value.",
-          "name": "value",
+        "resource": {
+          "description": "A specific resource to import.",
+          "name": "resource",
           "required": false
         }
       },
-      "description": "Update environment variable via \"checkly env update <key> <value>\".",
+      "description": "Import existing resources from your Checkly account to your project.\n\nBy default, all resources that can be imported will be imported. However, you\nmay fine-tune the process by including or excluding any combination of\nresources.\n\nThe import process consists of three steps:\n\n1. Creating a plan, which generates the appropriate code for your resources\n2. Applying the plan, which links your resources to the generated code\n3. Committing the plan, which finalizes the import session\n\nCREATING A PLAN\n\nCreating a plan carries no risk as no concrete links to your Checkly resources\nare made at this point. However, if you accidentally deploy the generated code\nbefore applying the plan, you will end up with duplicate resources and will\nnot be able to complete the import session without first deleting the\nduplicates.\n\nFor the curious, you may also preview the generated code with the '--preview'\noption. No plan will be created, allowing you to leisurely inspect the\ngenerated code. However keep in mind that you will need to create a plan to\nactually import any resources, at which point the code will be generated\nagain.\n\nYou may cancel any plan you've created without affecting any of the\nunderlying resources.\n\nAPPLYING A PLAN\n\nApplying a plan links your existing resources to the generated code. You\nshould carefully review the generated code to make sure that it contains the\nresources you expect before applying a plan. After a plan has been applied,\nany deployments of those resources will irreversibly modify the underlying\nCheckly resources. However, as a fail safe against concurrent use, any\ndeployments not including the imported resources will not delete the\nunderlying resources (or the links to the resources). This means that there\nis no need to block deployments while working on an import session.\n\nEven after you've applied a plan, you may still cancel it, which will unlink\nthe underlying resources from your project once more. However, keep in mind\nthat any changes to the resources that you've already deployed cannot be\nundone.\n\nCOMMITTING A PLAN\n\nFinally, committing a plan removes all fail safes and permanently links the\nimported resources to your project. Any resources you remove from your code\nwill result in the underlying resources also getting irrevocably deleted on\nthe next deploy. You should only commit your plan once you are sure that all\nfuture deployments include the imported resources.",
       "flags": {
-        "locked": {
-          "char": "l",
-          "description": "Indicate if environment variable is locked.",
-          "name": "locked",
+        "config": {
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "name": "config",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "root": {
+          "description": "The root folder in which to write generated code files.",
+          "name": "root",
+          "default": "__checks__",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "preview": {
+          "description": "Preview generated code without creating an actual import plan.",
+          "name": "preview",
           "allowNo": false,
           "type": "boolean"
         },
-        "secret": {
-          "char": "s",
-          "description": "Indicate if environment variable is secret.",
-          "exclusive": [
-            "locked"
-          ],
-          "name": "secret",
+        "debug-import-plan": {
+          "description": "Output the import plan to a file.",
+          "hidden": true,
+          "name": "debug-import-plan",
           "allowNo": false,
           "type": "boolean"
+        },
+        "debug-import-plan-input-file": {
+          "description": "A file to load an import plan from.",
+          "hidden": true,
+          "name": "debug-import-plan-input-file",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "debug-import-plan-output-file": {
+          "description": "The file to output the import plan to.",
+          "hidden": true,
+          "name": "debug-import-plan-output-file",
+          "default": "./debug-import-plan.json",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hidden": false,
-      "hiddenAliases": [],
-      "id": "env:update",
+      "hiddenAliases": [
+        "import"
+      ],
+      "id": "import:plan",
       "pluginAlias": "checkly",
       "pluginName": "checkly",
       "pluginType": "core",
-      "strict": true,
+      "strict": false,
       "enableJsonFlag": false,
       "coreCommand": false,
-      "readOnly": false,
+      "readOnly": true,
       "destructive": false,
       "idempotent": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "env",
-        "update.js"
+        "import",
+        "plan.js"
       ]
     },
     "incidents:create": {
@@ -2159,5 +2320,5 @@
       ]
     }
   },
-  "version": "7.5.5"
+  "version": "7.6.0"
 }