Get Current Period Usage

curl --request GET \
  --url https://api.example.com/api/v1/usage/current-period \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/v1/usage/current-period', 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.example.com/api/v1/usage/current-period",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.example.com/api/v1/usage/current-period"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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.example.com/api/v1/usage/current-period")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "period_start": "<string>",
  "period_end": "<string>",
  "used_credits": 123,
  "quota_credits": 123,
  "percentage_used": 123,
  "next_refresh_date": "<string>",
  "quota_enabled": true,
  "total_duration_seconds": 123,
  "used_amount_usd": 123,
  "quota_amount_usd": 123,
  "currency": "<string>",
  "price_per_second_usd": 123,
  "balance": 123,
  "price_per_minute": 123,
  "balance_enabled": true,
  "spent_this_period": 123,
  "managed_by_agency": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

usage

current-period

Get Current Period Usage

curl --request GET \
  --url https://api.example.com/api/v1/usage/current-period \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/api/v1/usage/current-period', 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.example.com/api/v1/usage/current-period",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.example.com/api/v1/usage/current-period"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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.example.com/api/v1/usage/current-period")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "period_start": "<string>",
  "period_end": "<string>",
  "used_credits": 123,
  "quota_credits": 123,
  "percentage_used": 123,
  "next_refresh_date": "<string>",
  "quota_enabled": true,
  "total_duration_seconds": 123,
  "used_amount_usd": 123,
  "quota_amount_usd": 123,
  "currency": "<string>",
  "price_per_second_usd": 123,
  "balance": 123,
  "price_per_minute": 123,
  "balance_enabled": true,
  "spent_this_period": 123,
  "managed_by_agency": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization

string | null

X-API-Key

string | null

Response

Successful Response

period_start

string

required

period_end

string

required

used_credits

number

required

quota_credits

integer

required

percentage_used

number

required

next_refresh_date

string

required

quota_enabled

boolean

required

total_duration_seconds

integer

required

used_amount_usd

number | null

quota_amount_usd

number | null

currency

string | null

price_per_second_usd

number | null

balance

number | null

price_per_minute

number | null

balance_enabled

boolean | null

spent_this_period

number | null

managed_by_agency

boolean | null

Start

Endpoints

Get Current Period Usage

Authorizations

Headers

Response