list-budget-suggestions

dci list-budget-suggestions

Returns the pending AI-generated budget suggestions for your account. The set is small (a handful of pending suggestions) and is returned in full. Each suggestion can be accepted (after you create a matching budget via POST /analytics/v1/budgets) or dismissed.

CLI default view

dci list-budget-suggestions presents a curated table by default:

Columns: name, amount (the amount object folded into one money cell, e.g. $3,120), confidence, interval (from timeInterval), and status.
--output json and explicit -C/--fields selections return the raw fields documented below.

Output

OK - The request succeeded.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
`items`	array of object	Array of pending budget suggestions.
`items[].id`	string
`items[].name`	string
`items[].description`	string
`items[].rationale`	string	Explanation of why this budget is suggested.
`items[].confidence`	string	One of: `"high"`, `"medium"`, `"low"`.
`items[].amount`	object	Suggested budget amount as a decimal-string value with its currency.
`items[].amount.amount`	string	Decimal string, e.g. "1234.56".
`items[].amount.currency`	string
`items[].timeInterval`	string
`items[].alertThresholds`	array of number (double)	Suggested alert thresholds as percentages of the amount.
`items[].scopeChips`	array of object	Human-readable summary of the suggested budget scope.
`items[].scopeChips[].key`	string
`items[].scopeChips[].values`	array of string
`items[].config`	object	Draft budget configuration to merge over the create-budget defaults.
`items[].generatedTime`	string (date-time)	Timestamp when the suggestion was generated.
`items[].status`	string	One of: `"pending"`, `"accepted"`, `"dismissed"`, `"skippedDraft"`.
`rowCount`	integer (int64)	Number of suggestions returned.

Raw JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "Array of pending budget suggestions.",
      "items": {
        "type": "object",
        "description": "An AI-generated budget recommendation.",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "rationale": {
            "type": "string",
            "description": "Explanation of why this budget is suggested."
          },
          "confidence": {
            "type": "string",
            "enum": [
              "high",
              "medium",
              "low"
            ]
          },
          "amount": {
            "type": "object",
            "description": "Suggested budget amount as a decimal-string value with its currency.",
            "properties": {
              "amount": {
                "type": "string",
                "description": "Decimal string, e.g. \"1234.56\"."
              },
              "currency": {
                "type": "string"
              }
            }
          },
          "timeInterval": {
            "type": "string"
          },
          "alertThresholds": {
            "type": "array",
            "description": "Suggested alert thresholds as percentages of the amount.",
            "items": {
              "type": "number",
              "format": "double"
            }
          },
          "scopeChips": {
            "type": "array",
            "description": "Human-readable summary of the suggested budget scope.",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "config": {
            "type": "object",
            "description": "Draft budget configuration to merge over the create-budget defaults.",
            "additionalProperties": true
          },
          "generatedTime": {
            "type": "string",
            "description": "Timestamp when the suggestion was generated.",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "accepted",
              "dismissed",
              "skippedDraft"
            ]
          }
        }
      }
    },
    "rowCount": {
      "type": "integer",
      "description": "Number of suggestions returned.",
      "format": "int64"
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
401	10	`AUTHENTICATION_FAILED`	Not signed in, or the API token is invalid. Run `dci login` or check `DCI_API_KEY`.
403	11	`PERMISSION_DENIED`	The DoiT user or the active customer context does not have access.
500	40	`API_SERVER_ERROR`	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listbudgetsuggestions

Output​

Errors​

Output

Errors