List observed event shapes and rule contract drift
curl --request GET \
--url https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes', 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.scrip.dev/v1/programs/{programId}/rules/event-shapes",
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.scrip.dev/v1/programs/{programId}/rules/event-shapes"
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))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes")
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{
"as_of": "2026-07-08T00:00:00Z",
"baseline_window": {
"from": "2026-07-01T00:00:00Z",
"payload_byte_limit": 2097152,
"payload_bytes_analyzed": 184320,
"payload_per_event_limit": 262144,
"payloads_omitted": 0,
"sample_limit": 50,
"sample_size": 42,
"to": "2026-07-08T00:00:00Z"
},
"current_window": {
"from": "2026-07-01T00:00:00Z",
"payload_byte_limit": 2097152,
"payload_bytes_analyzed": 184320,
"payload_per_event_limit": 262144,
"payloads_omitted": 0,
"sample_limit": 50,
"sample_size": 42,
"to": "2026-07-08T00:00:00Z"
},
"inventory": {
"fields": [
{
"dominant_type": "number",
"dominant_type_rate": 0.7333,
"missing_count": 3,
"missing_rate": 0.2,
"mixed": false,
"null_count": 1,
"null_rate": 0.0667,
"path": "event.amount",
"presence_rate": 0.8,
"present_count": 12,
"types": [
{
"count": 12,
"rate": 0.8,
"type": "number"
}
]
}
],
"payload_bytes_analyzed": 184320,
"payloads_omitted": 0,
"sample_size": 50,
"shapes": [
{
"event_name": "purchase.completed",
"event_type": "purchase",
"examples": [
{}
],
"fields": [
{
"dominant_type": "number",
"dominant_type_rate": 0.7333,
"missing_count": 3,
"missing_rate": 0.2,
"mixed": false,
"null_count": 1,
"null_rate": 0.0667,
"path": "event.amount",
"presence_rate": 0.8,
"present_count": 12,
"types": [
{
"count": 12,
"rate": 0.8,
"type": "number"
}
]
}
],
"first_observed_at": "2026-07-01T12:00:00Z",
"last_observed_at": "2026-07-08T12:00:00Z",
"sample_size": 15,
"truncated": false
}
],
"truncated": false
},
"observed_unreferenced": [
"event.debug"
],
"program_id": "550e8400-e29b-41d4-a716-446655440000",
"referenced_never_observed": [
"event.ammount"
],
"references": {
"dynamic_event_paths": [
"event.metadata[*]"
],
"event_paths": [
"event.amount"
]
},
"warnings": [
{
"baseline_type": "string",
"baseline_type_rate": 1,
"code": "referenced_event_field_never_observed",
"current_type": "number",
"current_type_rate": 0.8,
"event_name": "purchase.completed",
"event_type": "purchase",
"message": "<string>",
"path": "event.ammount",
"referenced": true,
"variant": "dominant"
}
]
}{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}{
"code": "not_found",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Resource not found"
}{
"code": "internal_error",
"message": "An internal error occurred"
}Individual rules
List observed event shapes
Infer field presence and JSON type distributions from bounded recent external events, compare the immediately preceding window, and surface active-rule reference gaps. Examples are redacted and truncated; findings never block saves or ingestion.
GET
/
v1
/
programs
/
{programId}
/
rules
/
event-shapes
List observed event shapes and rule contract drift
curl --request GET \
--url https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes', 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.scrip.dev/v1/programs/{programId}/rules/event-shapes",
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.scrip.dev/v1/programs/{programId}/rules/event-shapes"
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))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/programs/{programId}/rules/event-shapes")
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{
"as_of": "2026-07-08T00:00:00Z",
"baseline_window": {
"from": "2026-07-01T00:00:00Z",
"payload_byte_limit": 2097152,
"payload_bytes_analyzed": 184320,
"payload_per_event_limit": 262144,
"payloads_omitted": 0,
"sample_limit": 50,
"sample_size": 42,
"to": "2026-07-08T00:00:00Z"
},
"current_window": {
"from": "2026-07-01T00:00:00Z",
"payload_byte_limit": 2097152,
"payload_bytes_analyzed": 184320,
"payload_per_event_limit": 262144,
"payloads_omitted": 0,
"sample_limit": 50,
"sample_size": 42,
"to": "2026-07-08T00:00:00Z"
},
"inventory": {
"fields": [
{
"dominant_type": "number",
"dominant_type_rate": 0.7333,
"missing_count": 3,
"missing_rate": 0.2,
"mixed": false,
"null_count": 1,
"null_rate": 0.0667,
"path": "event.amount",
"presence_rate": 0.8,
"present_count": 12,
"types": [
{
"count": 12,
"rate": 0.8,
"type": "number"
}
]
}
],
"payload_bytes_analyzed": 184320,
"payloads_omitted": 0,
"sample_size": 50,
"shapes": [
{
"event_name": "purchase.completed",
"event_type": "purchase",
"examples": [
{}
],
"fields": [
{
"dominant_type": "number",
"dominant_type_rate": 0.7333,
"missing_count": 3,
"missing_rate": 0.2,
"mixed": false,
"null_count": 1,
"null_rate": 0.0667,
"path": "event.amount",
"presence_rate": 0.8,
"present_count": 12,
"types": [
{
"count": 12,
"rate": 0.8,
"type": "number"
}
]
}
],
"first_observed_at": "2026-07-01T12:00:00Z",
"last_observed_at": "2026-07-08T12:00:00Z",
"sample_size": 15,
"truncated": false
}
],
"truncated": false
},
"observed_unreferenced": [
"event.debug"
],
"program_id": "550e8400-e29b-41d4-a716-446655440000",
"referenced_never_observed": [
"event.ammount"
],
"references": {
"dynamic_event_paths": [
"event.metadata[*]"
],
"event_paths": [
"event.amount"
]
},
"warnings": [
{
"baseline_type": "string",
"baseline_type_rate": 1,
"code": "referenced_event_field_never_observed",
"current_type": "number",
"current_type_rate": 0.8,
"event_name": "purchase.completed",
"event_type": "purchase",
"message": "<string>",
"path": "event.ammount",
"referenced": true,
"variant": "dominant"
}
]
}{
"code": "bad_request",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Missing or invalid credentials"
}{
"code": "not_found",
"details": {
"expected": "uuid",
"field": "asset_id",
"fields": [
{
"expected": "<unknown>",
"field": "amount",
"message": "This field is required",
"reason": "required",
"received": "-10.00"
}
],
"reason": "invalid",
"received": "not-a-uuid"
},
"message": "Resource not found"
}{
"code": "internal_error",
"message": "An internal error occurred"
}Samples recent events and groups payloads by top-level event type and name. The
inventory reports field presence, missing and null counts, observed JSON types, and redacted examples. current_window and baseline_window show drift.
The response also compares observed fields with the fields active rules read (referenced_never_observed, observed_unreferenced). Use it to check event.* names before you write conditions, and to investigate fields that disappeared or changed type. warnings never block rule saves or event ingestion.
window_days, sample_limit, and as_of control the sample. Pass as_of when you need the same sample again. If payloads were truncated or omitted, payloads_omitted and the window byte-limit fields say so.
See Writing rules: Validate a condition.Authorizations
ApiKeyAuthBearerAuth
API key passed in the X-API-Key header.
Path Parameters
Program ID
Query Parameters
Current and baseline window width in days (1-30)
Required range:
1 <= x <= 30Maximum events sampled per window (1-100)
Required range:
1 <= x <= 100Exclusive end of the current ingestion-time window (RFC3339; defaults to request time)
Response
Observed shape inventory and drift warnings
Example:
"2026-07-08T00:00:00Z"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
["event.debug"]
Example:
"550e8400-e29b-41d4-a716-446655440000"
Example:
["event.ammount"]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I