apic reports:cloudInactiveCorgReportTable

Inactive consumer orgs report table

Synopsis

Return the data needed to populate the Inactive consumer organizations report table at cloud scope.

Asynchronous report generation: This is an asynchronous endpoint. The typical workflow is:

1. Initial request: Make your first API call with the desired parameters (type, timeframe, start/end dates, etc.)
2. 202 response: If the report is not yet generated, you'll receive a 202 (Accepted) status with a message indicating the report is being generated
3. Polling: Poll the same endpoint every 30-60 seconds (do not poll more frequently to avoid unnecessary load)
4. 200 response: Once the report is ready, you'll receive a 200 (OK) status with the complete report data

Regenerating reports:

• Cached reports are returned immediately with a 200 status
• Use regenerate=true to force generation of a fresh report (this will return 202 and require polling)
• Reports are cached based on the scope, type, and time period parameters

apic reports:cloudInactiveCorgReportTable --mode analytics [flags]

Possible Usages

apic reports:cloudInactiveCorgReportTable --mode analytics [flags]

Options

      --accept-language string                          Natural language and locale that the client prefers.
      --analytics-service string                        Analytics service name or ID. (required)
      --end string                                      If set, only return events with a datetime equal or older than this. The date-time value must be such that the time component represents midnight. for example, 2021-07-21T00:00:000Z.
                                                        
      --forecast                                        If set to true, includes forecasted data projections in the report response based on historical trends. The forecast extends beyond the current date to provide predictive analytics for future API usage patterns. This parameter is useful for trend analysis.
                                                        
      --format string                                   Output format. One of [json yaml octet-stream go-template=... go-template-file=...], defaults to yaml.
      --gateway_service_name string                     Filter results by gateway service name (only included for apigw services).
      --inactive-consumer-report-type no_applications   Type of inactive consumer report to query. Specifies which category of inactive consumer organizations to retrieve. Possible values: no_applications (Consumer organizations with no applications created), `no_subscriptions` (Consumer organizations with no active subscriptions to products), `no_traffic` (Consumer organizations with no API traffic at all), `no_recent_traffic` (Consumer organizations with no recent API traffic within the specified time period). (required)
      --limit string                                    If set, the number of items to return when requesting a list. Maximum: 500
      --offset string                                   If set, the offset to be applied when requesting a list. e.g. return events starting from the 100th result
      --output string                                   Write file(s) to directory, instead of STDOUT (default "-")
      --provider_org_name string                        Filter results by provider organization name.
      --regenerate                                      If true, forces the regeneration of an analytics report. Use this when you need fresh data or when the cached report is outdated. When set to true, the API will return a 202 status with a polling message, and you'll need to poll the endpoint again to get the regenerated report.
                                                        
      --search string                                   Filter results by search string
  -s, --server string                                   management server endpoint (required)
      --start string                                    If set, only return events with a date equal to or newer than this. The date-time value must be such that the time component represents midnight. for example, 2021-07-21T00:00:000Z.
                                                        
      --timeframe string                                If set, only return events within the indicated timeframe. Timeframe values are in the format of 'last<value><unit>' where <value> is a positive integer greater than one, and <unit> can be one of day, month, quarter or year.
                                                        
      --use_gateway_validation                          Indicates whether the request is coming from the wmapigw. This is an internal-use parameter.

Options inherited from parent commands

      --accept-license                  Accept the license for API Connect
      --certificate-authority strings   Path to a cert file for the certificate authority
      --debug                           Enable debug output
      --debug-output string             Write debug output to file
      --insecure-skip-pkix-validation   Skip verifying the complete TLS certificate chain (insecure)
      --insecure-skip-tls-verify        If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --lang string                     Toolkit operation language
      --live-help                       Enable or disable tracking of limited usage information
  -m, --mode string                     Toolkit operation mode (default "apim")
      --tls-server-name string          Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used