Scaffold a contract from live traffic
Infers a contract for one event from the window. The response body is PUT-able to /client/v1/contracts as-is.
Rules: type is the dominant observed JSON type; required is true when the key is present on at least 99% of events in the window; internal $-prefixed properties are excluded unless include_internal=1; keys that are always null or under 1% coverage are returned in skipped with a reason, so a dead field does not look like a missing one.
Review required before storing — inference from one window is a starting point, not a decision.
curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/contracts/suggest?location_id=example_string&event=order_completed&date_from=2026-07-27&date_to=2026-08-03&sample=10&include_internal=0" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/contracts/suggest?location_id=example_string&event=order_completed&date_from=2026-07-27&date_to=2026-08-03&sample=10&include_internal=0"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/contracts/suggest?location_id=example_string&event=order_completed&date_from=2026-07-27&date_to=2026-08-03&sample=10&include_internal=0", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://mythic-analytics.gulp.workers.dev/client/v1/contracts/suggest?location_id=example_string&event=order_completed&date_from=2026-07-27&date_to=2026-08-03&sample=10&include_internal=0", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/contracts/suggest?location_id=example_string&event=order_completed&date_from=2026-07-27&date_to=2026-08-03&sample=10&include_internal=0')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"event": "order_completed",
"properties": {},
"based_on": {
"total_events": 1000,
"window": {
"date_from": "last 1 day",
"date_to": "now",
"sample": {
"keeping": "1/10 of events",
"note": "example_string"
}
}
},
"skipped": [
{
"key": "legacy_flag",
"coverage": 0.04,
"reason": "always_null"
}
],
"note": "example_string"
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
/client/v1/contracts/suggest
Target server for requests. Edit to use your own host.
Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need contracts:read or contracts:write. See Using an mcp_ key over HTTP.
ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need contracts:read or contracts:write. See Using an mcp_ key over HTTP.Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_.
Event to infer a contract for.
Start of the window, ISO 8601 date or timestamp. Defaults to 1 day ago.
End of the window (inclusive day), ISO 8601. Defaults to now.
Keep a deterministic 1/N of events. Rates and coverage stay unbiased; counts become counts of the sample and are not scaled up. Use for wide windows on high-volume events — sample=10 handles 7 days of a 300k-event event name.
Set to 1 to include Mythic's own $-prefixed properties.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need contracts:read or contracts:write. See Using an mcp_ key over HTTP.
Query Parameters
Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_.
Start of the window, ISO 8601 date or timestamp. Defaults to 1 day ago.
2026-07-27Keep a deterministic 1/N of events. Rates and coverage stay unbiased; counts become counts of the sample and are not scaled up. Use for wide windows on high-volume events — sample=10 handles 7 days of a 300k-event event name.
10