Logs and health

Get integration health (alerts, errors, insights)

Computed health overview of your integration, Stripe-Workbench style:

alerts — things needing action now: auto-disabled webhook endpoints, endpoints accumulating consecutive failures, deliveries currently in the automatic retry cycle, deliveries that exhausted retries in the last 24h.
errors — API request error groups from the last 7 days (route + status
- error code + count), sourced from the request log.
insights — recommendations: missing webhook registration, low delivery success rate, high API latency, noisiest failing route.
summary — 7-day webhook success rate, delivery counts, API request and error counts, and average API latency.

Permissions: requires view access to “Webhooks”.

Authentication: send your organization API key in the X-API-Key header.

GET

organization

health

Get integration health (alerts, errors, insights)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/health \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.hyperprop.com/platform/v1/organization/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.hyperprop.com/platform/v1/organization/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 => [
    "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.hyperprop.com/platform/v1/organization/health"

	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.hyperprop.com/platform/v1/organization/health")

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

{
  "success": true,
  "data": {
    "generatedAt": "<string>",
    "alerts": [
      {
        "id": "webhook-disabled-d2f3a1c0",
        "severity": "critical",
        "title": "Webhook endpoint auto-disabled",
        "description": "<string>"
      }
    ],
    "errors": [
      {
        "route": "POST /platform/v1/organization/lockouts",
        "statusCode": 400,
        "errorCode": "VALIDATION_ERROR",
        "count": 12,
        "lastSeenAt": "<string>"
      }
    ],
    "insights": [
      {
        "id": "low-success-rate",
        "title": "<string>",
        "description": "<string>"
      }
    ],
    "summary": {
      "webhookSuccessRate7d": 93.33,
      "deliveries7d": 123,
      "failedDeliveries7d": 123,
      "retryingNow": 123,
      "apiRequests7d": 123,
      "apiErrors7d": 123,
      "apiAvgLatencyMs": 120
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Response

Computed integration health

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Get integration health (alerts, errors, insights)

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/health \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.hyperprop.com/platform/v1/organization/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.hyperprop.com/platform/v1/organization/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 => [
    "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.hyperprop.com/platform/v1/organization/health"

	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.hyperprop.com/platform/v1/organization/health")

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

{
  "success": true,
  "data": {
    "generatedAt": "<string>",
    "alerts": [
      {
        "id": "webhook-disabled-d2f3a1c0",
        "severity": "critical",
        "title": "Webhook endpoint auto-disabled",
        "description": "<string>"
      }
    ],
    "errors": [
      {
        "route": "POST /platform/v1/organization/lockouts",
        "statusCode": 400,
        "errorCode": "VALIDATION_ERROR",
        "count": 12,
        "lastSeenAt": "<string>"
      }
    ],
    "insights": [
      {
        "id": "low-success-rate",
        "title": "<string>",
        "description": "<string>"
      }
    ],
    "summary": {
      "webhookSuccessRate7d": 93.33,
      "deliveries7d": 123,
      "failedDeliveries7d": 123,
      "retryingNow": 123,
      "apiRequests7d": 123,
      "apiErrors7d": 123,
      "apiAvgLatencyMs": 120
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required",
  "code": "UNAUTHORIZED"
}

{
  "success": false,
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Access denied",
  "code": "FORBIDDEN"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Get integration health (alerts, errors, insights)

Authorizations

Response