Platform Service Health

curl --request GET \
  --url https://api.example.com/api/partners/v2.0/platform/service-health \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/api/partners/v2.0/platform/service-health"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.example.com/api/partners/v2.0/platform/service-health', 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/partners/v2.0/platform/service-health",
  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.example.com/api/partners/v2.0/platform/service-health"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/partners/v2.0/platform/service-health")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/platform/service-health")

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

{
  "generated_at": "2023-11-07T05:31:56Z",
  "scope": {
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "device_type": "heat_pump",
    "population": "physical"
  },
  "coverage": {
    "expected_devices": 123,
    "evaluated_devices": 123,
    "missing_record_devices": 123,
    "lapsed_devices": 123,
    "newest_record_change_at": "2023-11-07T05:31:56Z"
  },
  "overall": {
    "total": 123,
    "applicable": 123,
    "blocked": 123,
    "evaluable": 123,
    "counts": {},
    "affected": 123,
    "unknown": 123,
    "healthy_share": 123
  },
  "overall_reasons": [
    {
      "status": "healthy",
      "reason": "<string>",
      "devices": 123
    }
  ],
  "services": [
    {
      "id": "oem_auth",
      "summary": {
        "total": 123,
        "applicable": 123,
        "blocked": 123,
        "evaluable": 123,
        "counts": {},
        "affected": 123,
        "unknown": 123,
        "healthy_share": 123
      },
      "manufacturers": [
        {
          "manufacturer": "<string>",
          "summary": {
            "total": 123,
            "applicable": 123,
            "blocked": 123,
            "evaluable": 123,
            "counts": {},
            "affected": 123,
            "unknown": 123,
            "healthy_share": 123
          }
        }
      ],
      "reasons": [
        {
          "status": "healthy",
          "reason": "<string>",
          "devices": 123
        }
      ]
    }
  ],
  "contract": "fleet-service-health",
  "schema_version": 2
}