Get usage summary v2

Get usage summary

curl --request GET \
  --url https://api.checklyhq.com/v2/usage/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.checklyhq.com/v2/usage/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v2/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 <token>"
  ],
]);

$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/v2/usage/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v2/usage/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "usageTermsIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "totals": {
    "creditsUsed": 1
  },
  "breakdown": [
    {
      "usageTermsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingRuleKey": "apiChecks",
      "period": {
        "from": "2023-12-25",
        "to": "2023-12-25"
      },
      "pricingRule": {
        "method": "per_unit",
        "quantity": 1,
        "unit": "<string>",
        "credits": 1,
        "rates": [
          {
            "when": "<string>",
            "credits": 1
          }
        ],
        "included": {
          "quantity": 1,
          "period": "<string>"
        }
      },
      "calculations": [
        {
          "rateCondition": "<string>",
          "measuredQuantity": 1,
          "includedQuantity": 1,
          "billableQuantity": 1,
          "creditsUsed": 1
        }
      ],
      "creditsUsed": 1,
      "accountId": "<string>"
    }
  ],
  "coverage": {
    "gaps": [
      {
        "from": "2023-12-25",
        "to": "2023-12-25"
      }
    ]
  }
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

GET

usage

summary

Get usage summary

curl --request GET \
  --url https://api.checklyhq.com/v2/usage/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.checklyhq.com/v2/usage/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v2/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 <token>"
  ],
]);

$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/v2/usage/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v2/usage/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "usageTermsIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "totals": {
    "creditsUsed": 1
  },
  "breakdown": [
    {
      "usageTermsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "pricingRuleKey": "apiChecks",
      "period": {
        "from": "2023-12-25",
        "to": "2023-12-25"
      },
      "pricingRule": {
        "method": "per_unit",
        "quantity": 1,
        "unit": "<string>",
        "credits": 1,
        "rates": [
          {
            "when": "<string>",
            "credits": 1
          }
        ],
        "included": {
          "quantity": 1,
          "period": "<string>"
        }
      },
      "calculations": [
        {
          "rateCondition": "<string>",
          "measuredQuantity": 1,
          "includedQuantity": 1,
          "billableQuantity": 1,
          "creditsUsed": 1
        }
      ],
      "creditsUsed": 1,
      "accountId": "<string>"
    }
  ],
  "coverage": {
    "gaps": [
      {
        "from": "2023-12-25",
        "to": "2023-12-25"
      }
    ]
  }
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>",
  "code": "ACCOUNT_NOT_IN_USAGE_TERMS"
}

Authorizations

Authorization

string

header

required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. 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<uuid>

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Query Parameters

from

string<date>

Inclusive UTC date. Defaults to the earliest selected usage start, or to.

string<date>

Inclusive UTC date. Defaults to today.

usageTermsIds

string<uuid>[]

Required array length: 1 - 100 elements

accountIds

string[]

Required array length: 1 - 100 elements

pricingRuleKeys

enum<string>[]

Required array length: 1 - 100 elements

Available options:

apiChecks,

multistepChecks,

browserChecks,

playwrightCheckSuites,

uptimeMonitors,

aiInvocations,

statusPages,

statusPageAdditionalServices,

statusPageAdditionalSubscribers,

additionalSms,

additionalPhoneAlerts

Response

Successful

period

object

required

Show child attributes

usageTermsIds

string<uuid>[]

required

totals

object

required

Show child attributes

breakdown

object[]

required

Show child attributes

coverage

object

required

Dates outside organization usage terms. Credits for gaps are unknown; deliberately filtered terms are excluded.

Show child attributes

Getting Started

API Reference

Authorizations

Headers

Query Parameters

Response