# Get usage summary v1 - Checkly Docs > Get usage totals and contract projections for a date range. Source: https://www.checklyhq.com/docs/api-reference/usage/get-usage-summary/ --- Get organization usage totals and projections. ``` curl --request GET \ --url https://api.checklyhq.com/v1/usage/summary \ --header 'Authorization: Bearer ' ``` ``` import requests url = "https://api.checklyhq.com/v1/usage/summary" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ``` const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch('https://api.checklyhq.com/v1/usage/summary', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err)); ``` ``` "https://api.checklyhq.com/v1/usage/summary", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Bearer " ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ``` ``` package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.checklyhq.com/v1/usage/summary" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` ``` HttpResponse response = Unirest.get("https://api.checklyhq.com/v1/usage/summary") .header("Authorization", "Bearer ") .asString(); ``` ``` require 'uri' require 'net/http' url = URI("https://api.checklyhq.com/v1/usage/summary") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ``` { "usageTermsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "period": { "from": "2023-12-25", "to": "2023-12-25" }, "totals": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projections": { "weeksSinceStart": 1, "weeksRemaining": 1, "remainingCredits": 123, "windows": { "sinceStart": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 }, "last30Days": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 }, "last7Days": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 }, "last1Day": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 } } } } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` Usage # Get usage summary v1 deprecated Get usage totals and contract projections for a date range. GET / v1 / usage / summary Get organization usage totals and projections. ``` curl --request GET \ --url https://api.checklyhq.com/v1/usage/summary \ --header 'Authorization: Bearer ' ``` ``` import requests url = "https://api.checklyhq.com/v1/usage/summary" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ``` const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch('https://api.checklyhq.com/v1/usage/summary', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err)); ``` ``` "https://api.checklyhq.com/v1/usage/summary", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "Authorization: Bearer " ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ``` ``` package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.checklyhq.com/v1/usage/summary" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` ``` HttpResponse response = Unirest.get("https://api.checklyhq.com/v1/usage/summary") .header("Authorization", "Bearer ") .asString(); ``` ``` require 'uri' require 'net/http' url = URI("https://api.checklyhq.com/v1/usage/summary") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ``` { "usageTermsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "period": { "from": "2023-12-25", "to": "2023-12-25" }, "totals": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projections": { "weeksSinceStart": 1, "weeksRemaining": 1, "remainingCredits": 123, "windows": { "sinceStart": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 }, "last30Days": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 }, "last7Days": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 }, "last1Day": { "usage": { "credits": { "used": 1, "percentOfBudget": 1 }, "meters": [ { "meterType": "CHECK_RUN", "measures": { "totalRuns": 1, "finalRuns": 1, "retryRuns": 1, "cancelledRuns": 1, "multiStepRequests": 1, "playwrightBillableDurationMs": 1, "degradedRuns": 1, "failedRuns": 1, "errorRuns": 1, "abortedRuns": 1, "overMaxResponseTimeRuns": 1, "standardBillableUnits": 1, "premiumBillableUnits": 1 } } ] }, "projectedAnnualPercentOfBudget": 1, "projectedCreditsAtContractEnd": 1, "projectedPercentAtContractEnd": 1, "projectedWeeksUntilExhausted": 1 } } } } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` ``` { "statusCode": 123, "error": " ", "message": " " } ``` This v1 endpoint is deprecated. Use [v2 summary](https://www.checklyhq.com/docs/api-reference/usage/get-consumption-across-usage-terms-with-a-calculation-breakdown-for-each-pricing-rule) for consumption and [term projections](https://www.checklyhq.com/docs/api-reference/usage/project-whole-term-credit-consumption-from-completed-utc-days-using-v2-pricing-rules) for forecasts. #### Authorizations ​ Authorization string header required The Checkly Public API uses API keys to authenticate requests. You can get the API Key [here](https://app.checklyhq.com/settings/user/api-keys). Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: `curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"` #### Headers ​ x-checkly-account string Your Checkly account ID, you can find it at [https://app.checklyhq.com/settings/account/general](https://app.checklyhq.com/settings/account/general) #### Query Parameters ​ to string Date used to resolve usage terms. Defaults to today. ​ from string Start date, inclusive. Defaults to the resolved usage start date. ​ accountIds string[] | null Account IDs included in the resolved usage terms. Repeat or comma-separate values. ​ checkTypes enum[] | null Check types to include. Repeat or comma-separate values. Available options: `AGENTIC`, `API`, `BROWSER`, `HEARTBEAT`, `ICMP`, `MULTI_STEP`, `TCP`, `PLAYWRIGHT`, `URL`, `DNS`, `SSL`, `GRPC`, `TRACEROUTE` #### Response Successful ​ usageTermsId string | null required ​ period object required Show child attributes ​ totals object required Credit usage is derived from CHECK_RUN billable units only; other meters are not priced into credits. Show child attributes ​ projections object required Show child attributes Was this page helpful? [Suggest edits](https://github.com/checkly/docs/edit/main/api-reference/usage/get-usage-summary.mdx)[Raise issue](https://github.com/checkly/docs/issues/new?title=Issue%20on%20docs&body=Path:%20/api-reference/usage/get-usage-summary) [Get usage terms v1 Previous](https://www.checklyhq.com/docs/api-reference/usage/get-usage-terms)[Get usage series v1 Next](https://www.checklyhq.com/docs/api-reference/usage/get-usage-series) [x](https://x.com/checklyhq)[github](https://github.com/checkly)[linkedin](https://linkedin.com/company/checkly) [Powered by This documentation is built and hosted on Mintlify, a developer documentation platform](https://www.mintlify.com/?utm_campaign=poweredBy&utm_medium=referral&utm_source=checkly-422f444a)