1# Forecast API Examples
2 
3Common forecast patterns with request bodies. Use the [SKILL.md workflow](../SKILL.md) to construct and execute the `az rest` command.
4 
5## 1. Forecast Rest of Current Month (Daily)
6 
7```json
8{
9  "type": "ActualCost",
10  "timeframe": "Custom",
11  "timePeriod": {
12    "from": "<first-of-month>",
13    "to": "<last-of-month>"
14  },
15  "dataset": {
16    "granularity": "Daily",
17    "aggregation": {
18      "totalCost": { "name": "Cost", "function": "Sum" }
19    },
20    "sorting": [
21      { "direction": "Ascending", "name": "UsageDate" }
22    ]
23  },
24  "includeActualCost": true,
25  "includeFreshPartialCost": true
26}
27```
28 
29> 💡 **Tip:** Set `from` to the first of the month — the response contains `Actual` rows up to today and `Forecast` rows for remaining days.
30 
31---
32 
33## 2. Forecast Next 3 Months (Monthly)
34 
35```json
36{
37  "type": "ActualCost",
38  "timeframe": "Custom",
39  "timePeriod": {
40    "from": "<first-of-month>",
41    "to": "<3-months-out>"
42  },
43  "dataset": {
44    "granularity": "Monthly",
45    "aggregation": {
46      "totalCost": { "name": "Cost", "function": "Sum" }
47    },
48    "sorting": [
49      { "direction": "Ascending", "name": "BillingMonth" }
50    ]
51  },
52  "includeActualCost": true,
53  "includeFreshPartialCost": true
54}
55```
56 
57> 💡 **Tip:** Monthly granularity uses the `BillingMonth` column in the response.
58 
59---
60 
61## 3. Forecast for Resource Group Scope
62 
63```json
64{
65  "type": "ActualCost",
66  "timeframe": "Custom",
67  "timePeriod": {
68    "from": "<start-date>",
69    "to": "<end-date>"
70  },
71  "dataset": {
72    "granularity": "Daily",
73    "aggregation": {
74      "totalCost": { "name": "Cost", "function": "Sum" }
75    },
76    "sorting": [
77      { "direction": "Ascending", "name": "UsageDate" }
78    ]
79  },
80  "includeActualCost": true,
81  "includeFreshPartialCost": true
82}
83```
84 
85> 💡 **Tip:** Scope is set at the URL level. Use the resource group scope URL to limit the forecast.
86 
87---
88 
89## 4. Forecast for Billing Account Scope
90 
91```json
92{
93  "type": "ActualCost",
94  "timeframe": "Custom",
95  "timePeriod": {
96    "from": "<start-date>",
97    "to": "<end-date>"
98  },
99  "dataset": {
100    "granularity": "Monthly",
101    "aggregation": {
102      "totalCost": { "name": "Cost", "function": "Sum" }
103    },
104    "sorting": [
105      { "direction": "Ascending", "name": "BillingMonth" }
106    ]
107  },
108  "includeActualCost": true,
109  "includeFreshPartialCost": true
110}
111```
112 
113> 💡 **Tip:** Use URL pattern `/providers/Microsoft.Billing/billingAccounts/<id>/...`. Monthly granularity recommended for billing account forecasts.
114 
115---
116 
117## Scope URL Reference
118 
119| Scope | URL Pattern |
120|---|---|
121| Subscription | `/subscriptions/<subscription-id>/providers/Microsoft.CostManagement/forecast` |
122| Resource Group | `/subscriptions/<subscription-id>/resourceGroups/<rg-name>/providers/Microsoft.CostManagement/forecast` |
123| Billing Account | `/providers/Microsoft.Billing/billingAccounts/<id>/providers/Microsoft.CostManagement/forecast` |
124 
125> 💡 **Tip:** These are path-only patterns — not complete URLs. Append `?api-version=2023-11-01` when constructing the full request URL.
126