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.

Responses

200 (application/json)

OK - The request succeeded.

{
  "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"
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-budget-suggestions, listbudgetsuggestions