Which events can serve as the lead / conversion step
Inventories every non-system event in the window with its volume, its session coverage, and which JSON paths carry a monetary value — then suggests a conversion_event / lead_event / revenue_path you can pass straight to the main endpoint.
Session coverage is why this exists. The funnel is session-grained, so an event's coverage is a ceiling on what the analysis can see. Server-side conversions (CRM/webhook over Pub/Sub) never touch the browser and carry no session_id: choosing one would yield a funnel with zero conversions that the constraint logic then attributes to the landing page. Neither /client/v1/data/events/breakdown nor /client/v1/data/properties reports coverage, which is the gap this fills.
Reads only the events view — it does not require a synced Meta table.
curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/constraints/events?location_id=example_string&from=2024-12-25&to=2024-12-25&days=28" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/constraints/events?location_id=example_string&from=2024-12-25&to=2024-12-25&days=28"
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/constraints/events?location_id=example_string&from=2024-12-25&to=2024-12-25&days=28", {
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/constraints/events?location_id=example_string&from=2024-12-25&to=2024-12-25&days=28", 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/constraints/events?location_id=example_string&from=2024-12-25&to=2024-12-25&days=28')
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": {
"window": {
"from": "2024-12-25",
"to": "2024-12-25"
},
"suggested": {
"conversion_event": "example_string",
"revenue_path": "example_string",
"lead_event": "example_string",
"note": "example_string"
},
"events": [
{
"event_name": "John Doe",
"total_events": 42,
"sessions": 42,
"session_coverage": 3.14,
"person_coverage": 3.14,
"credited_via": "session",
"revenue_paths": [
"example_string"
],
"suggested_revenue_path": "example_string",
"usable": true,
"suggested_role": "conversion",
"warning": "example_string"
}
]
}
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Error",
"message": "This client has no BigQuery event dataset yet.",
"code": 424
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
/client/v1/constraints/events
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 constraints:read or constraints:write. See Using an mcp_ key over HTTP.
ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need constraints:read or constraints:write. See Using an mcp_ key over HTTP.Location to scope to. Required for ak_ keys (or send the X-Location-Id header).
Window start (YYYY-MM-DD). Defaults to 28 days before to.
Window end (YYYY-MM-DD), inclusive. Defaults to yesterday.
Window length in days, inclusive of both ends — the same shorthand /client/v1/data takes. days=90 ending yesterday is the usual call. Ignored when from is given explicitly. Out-of-range values are rejected, not clamped.
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 constraints:read or constraints: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).
Window start (YYYY-MM-DD). Defaults to 28 days before to.
Window end (YYYY-MM-DD), inclusive. Defaults to yesterday.
Window length in days, inclusive of both ends — the same shorthand /client/v1/data takes. days=90 ending yesterday is the usual call. Ignored when from is given explicitly. Out-of-range values are rejected, not clamped.