Skip to main content
GET
/
usage
/
fairness
Per-customer nesting-minutes usage breakdown
curl --request GET \
  --url https://dev.api.nestapi.com/usage/fairness \
  --header 'Accept: <accept>' \
  --header 'Authorization: <api-key>'
import requests

url = "https://dev.api.nestapi.com/usage/fairness"

headers = {
    "Accept": "<accept>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Accept: '<accept>', Authorization: '<api-key>'}};

fetch('https://dev.api.nestapi.com/usage/fairness', 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://dev.api.nestapi.com/usage/fairness",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Accept: <accept>",
    "Authorization: <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://dev.api.nestapi.com/usage/fairness"

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

	req.Header.Add("Accept", "<accept>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://dev.api.nestapi.com/usage/fairness")
  .header("Accept", "<accept>")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://dev.api.nestapi.com/usage/fairness")

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

request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "FairnessEnabled": true,
  "OverageEnabled": true,
  "IncludedMinutes": 123,
  "SharedBurstMinutes": 123,
  "Keys": [
    {
      "ApiKeyId": "<string>",
      "Weight": 123,
      "ConsumedMinutes": 123,
      "ReservedMinutes": 123,
      "OverageMinutes": 123,
      "EffectiveFloorMinutes": 123,
      "Sizing": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Response

200 - application/json

Success

FairnessUsageResponse

FairnessEnabled
boolean
OverageEnabled
boolean
IncludedMinutes
number<double>
SharedBurstMinutes
number<double>
Keys
FairnessKeyUsage · object[]