Skip to content
Retidal Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Auto
Light
Dark
Console
Get started
Home
Guides
Ingestion & Decisioning
Management
SDKs
MCP
Skills
Changelog
Home
Guides
Ingestion & Decisioning
Management
SDKs
MCP
Skills
Changelog
Management
Overview
Account
Current account info + linked identities
GET
Update display name only
PATCH
Change or set the account password
POST
Unlink an OAuth identity
DELETE
Alerts
List alert rules
GET
Create alert rule
POST
Get alert rule
GET
Delete alert rule
DELETE
Update alert rule (partial)
PATCH
List alert incidents (filterable, cursor via openedAt)
GET
Analytics
Project overview KPIs (clicks/visits/events/conversions) with prev-period delta
GET
Event analytics summary (by day / by type / by device)
GET
Visit/session analytics summary (by day / source / device / landing)
GET
Paginated raw event feed with rich filtering
GET
Paginated visit/session feed
GET
Attribution report (organic/paid, first/last touch)
GET
Ad-hoc funnel calculation
POST
Ad-hoc retention/cohort calculation
POST
Paginated visitor directory
GET
Visitor detail with recent activity window
GET
Paginated conversion-report list with stats
GET
Reset a conversion report and re-enqueue it for delivery (ADMIN)
POST
Per-platform conversion delivery stats
GET
List ad-platform pixel configs (credentials masked)
GET
Create an ad-platform pixel config (ADMIN)
POST
Update a pixel config (ADMIN)
PUT
Validate stored pixel credentials against the provider (VIEWER)
POST
Delete a pixel config (ADMIN)
DELETE
Update a pixel config (ADMIN, alias of PUT)
PATCH
ApiKeys
List a project's scoped API keys (raw key never returned)
GET
Issue a new scoped API key (raw key returned once)
POST
Revoke a scoped API key (project ADMIN)
DELETE
Update a scoped API key's scopes/name (project ADMIN)
PATCH
Auth
Email + password login
POST
Switch the tenant the session is scoped to
POST
Log out (clears session, 302 to /login)
POST
Current session principal + tenant context
GET
Tenants available to the current user (for the switcher)
GET
Fresh DB read of the user's UI locale
GET
Switch the logged-in user's UI language
PATCH
Fresh DB read of the user's timezone
GET
Self-serve register (email + password)
POST
Resend the email-verification link
POST
Verify email + set the login password (mailbox owner)
POST
Request a password-reset link
POST
Complete a password reset with a token
POST
Which OAuth providers are configured
GET
Begin OAuth login/signup (302 to provider)
GET
Begin linking an OAuth provider to the current account
GET
OAuth redirect callback (login / signup / link / accept invite)
GET
Automations
List automations (aggregated with 7d entries/runs sparkline)
GET
Create automation (definition + trigger + entry/exit) in one request
POST
Event catalog (registered ∪ auto-discovered) for automation triggers
GET
Cross-surface touchpoint overview (email triggers ∪ email-sending automations)
GET
Migrate a marketing email trigger into a single-node automation
POST
Generate an automation draft definition with Workers AI
POST
Workers AI targeted single-node edit of an automation definition
POST
Automation detail with version summaries
GET
Rename / enable / pause / update trigger config
PATCH
Save draft version (or validate-only for import gate)
PUT
Validate and publish the latest draft version
POST
Pure evaluation against a sample event (zero side effects)
POST
List runs (status filter, incl. derived "suppressed")
GET
Run detail (steps + effect_outbox terminal status join)
GET
Canvas live-metrics (per-node/edge trace aggregation)
GET
Query automation_trigger_log for an automation
GET
Campaigns
List marketing/ad campaigns
GET
Create a marketing/ad campaign
POST
Get a marketing/ad campaign with detail
GET
Update a marketing/ad campaign (PUT alias of PATCH)
PUT
Delete a marketing/ad campaign
DELETE
Update a marketing/ad campaign
PATCH
CouponPools
List coupon pools
GET
Create coupon pool (draft)
POST
Coupon pool detail with generation progress
GET
Update coupon pool status (suspend / archive)
PATCH
Trigger batch coupon generation (idempotent)
POST
CustomDomains
List custom domains
GET
Create (or revive) a custom domain
POST
Custom domain detail
GET
Retire and soft-delete a custom domain (cascade)
DELETE
Provision the Cloudflare custom hostname for a domain
POST
Refresh Cloudflare hostname status for a domain
POST
Provision the Route53 hosted zone (ns_delegation mode)
POST
Verify NS delegation and trigger one-shot Cloudflare hostname supply
POST
List subdomains of a domain
GET
Create (or revive) a subdomain (ns_delegation parent only)
POST
Retire and soft-delete a subdomain
DELETE
Debug
Get debug-mode switch status + remaining TTL (VIEWER)
GET
Enable / disable / renew debug mode (EDITOR)
POST
Incremental keyset stream of debug events (VIEWER)
GET
DecisionAnalytics
Decision ROI funnel (L1-L4) over a date range
GET
Manually backfill the decision-funnel daily aggregate (SUPER_ADMIN only)
POST
Paginated decision log (keyset)
GET
DerivedEvents
List derived event rules
GET
Create derived event rule
POST
Derived event rule detail
GET
Update derived event rule mutable fields
PATCH
Start / stop a derived event rule
POST
Delete a derived event rule
DELETE
EmailAssets
List attachment assets
GET
Upload an attachment asset (multipart)
POST
Delete an attachment asset
DELETE
Mint a short-TTL signed download URL for an asset
POST
Download an asset via signed capability URL (no session)
GET
Get dynamic-attachment domain allowlist
GET
Replace dynamic-attachment domain allowlist
PUT
EmailCampaigns
List email campaigns
GET
Create an email campaign (draft)
POST
Get a campaign
GET
Update a draft campaign
PATCH
Preview a campaign's audience
POST
Launch a draft campaign
POST
Pause a campaign
POST
Resume a paused campaign
POST
Campaign effectiveness report
GET
List email messages (recipient addresses masked)
GET
Message detail with lifecycle event timeline
GET
Email overview counters (30-day messages, campaigns, suppressions)
GET
[internal] Append a normalized email event
POST
EmailCompliance
Get compliance settings (company/address/contact/locale-strict)
GET
Replace compliance settings (whole-object PUT)
PUT
List opt-in consent history for an email
GET
Record an admin-entered consent grant/revoke
POST
EmailConfig
List email sending channels (providers)
GET
Create an email sending channel
POST
Partially update an email channel
PATCH
Read a channel's quota usage snapshot
GET
Rotate a channel's ESP callback webhookId
POST
Set/rotate a channel's ESP webhook signing secret
POST
Channel entity overview (topology + deliverability + activity)
GET
List sending domains
GET
Register a sending domain
POST
Trigger DNS verification for a domain (currently unsupported)
POST
Domain entity overview (topology + exact deliverability + activity)
GET
List routing rules
GET
Create a routing rule
POST
List campaign approval requests
GET
Approve or reject an approval request
POST
Deliverability daily aggregates + totals
GET
EmailIdentities
List sending identities
GET
Create a sending identity
POST
Delete a sending identity
DELETE
Update a sending identity
PATCH
EmailInbound
Get inbound (reply/forward) email config
GET
Update inbound config (no create/delete)
PUT
Re-trigger verification of the forward target
POST
EmailSuppressions
List suppression entries (addresses masked)
GET
Add a suppression entry
POST
Remove a suppression entry
DELETE
Bulk-import suppressions
POST
EmailTemplates
List email templates
GET
Create an email template
POST
Get one template
GET
Partially update a template
PATCH
List a template's language variants (draft + published)
GET
Create/overwrite a human-authored language variant
PUT
Delete a language variant
DELETE
Generate an AI draft translation for a locale
POST
Publish a draft language variant
POST
Per-template delivery-effectiveness report
GET
EmailTriggers
List event triggers
GET
Create an event trigger
POST
Delete a trigger
DELETE
Partially update a trigger
PATCH
Recent trigger activity log
GET
EventCatalog
List global standard event definitions (any authenticated dashboard user)
GET
List event definitions with usage (SUPER_ADMIN)
GET
Create an event definition (SUPER_ADMIN)
POST
Get an event definition (SUPER_ADMIN)
GET
Update an event definition (SUPER_ADMIN)
PUT
Delete an event definition (SUPER_ADMIN)
DELETE
List project event mappings (app event name → standard definition)
GET
Create a project event mapping (EDITOR)
POST
Delete a project event mapping (EDITOR)
DELETE
Sampled catalog of event property keys (autocomplete source)
GET
Paginated project event catalog with volumes, pixel mappings, consumers
GET
7-day per-event volume sparkline data (AE-derived, KV-cached)
GET
Downstream read-only topology graph for one event
GET
Update a project event's display name (EDITOR)
PATCH
Experiments
List A/B experiments
GET
Create A/B experiment
POST
Real-time aggregated experiment metrics
GET
Retrieve stored experiment conclusion
GET
Auto-generate and persist an experiment conclusion / recommendation
POST
Export
List raw-event export configs (credentials masked)
GET
Create an export config (EDITOR; encrypts credentials at rest)
POST
Get one export config (credentials masked)
GET
Delete an export config (ADMIN)
DELETE
Update an export config (EDITOR)
PATCH
Probe bucket write access with stored credentials (EDITOR)
POST
List recent export runs
GET
Re-queue an export partition run (EDITOR)
POST
List export backfill jobs
GET
Create an export backfill job (EDITOR; one active per config)
POST
Cancel a pending/running backfill job (EDITOR)
PATCH
Funnels
List saved funnels
GET
Create a saved funnel (ADMIN)
POST
Get one saved funnel
GET
Delete a saved funnel (ADMIN)
DELETE
Update a saved funnel (ADMIN)
PATCH
Growth
Growth metric time series (roas etc.)
GET
Growth dashboard (AARRR) snapshot vs previous period
GET
Engagement / active-user growth data
GET
Activation growth data
GET
Revenue growth data
GET
Get the project growth definition + templates + candidate events
GET
Create/update the growth definition (ADMIN)
PUT
IncentiveRules
List incentive rule versions
GET
Create a draft incentive rule version
POST
Incentive rule version detail
GET
Validate and publish a draft rule version (draft → active)
POST
Copy a historical rule version as a new active version
POST
Invitations
List pending invitations for the active tenant (min tenant ADMIN)
GET
Issue (or replace) a tenant invitation (min tenant ADMIN)
POST
Revoke a pending invitation (min tenant ADMIN)
DELETE
Preview an invitation by token
GET
Accept an invitation (create account or join with existing session)
POST
Journeys
List journeys (deprecated; use Automations)
GET
Create draft journey (deprecated)
POST
Publish a journey version with graph validation (deprecated)
POST
List journey instances (filterable, deprecated)
GET
Pause / resume / terminate a journey instance (deprecated)
PATCH
Links
List short links (paginated, filterable)
GET
Create a short link (single) or a batch (EDITOR)
POST
Get short link detail
GET
Update a short link (EDITOR)
PUT
Delete a short link (ADMIN)
DELETE
Update a short link (EDITOR, alias of PUT)
PATCH
Short link analytics (click/conversion time series)
GET
Loyalty
List loyalty programs
GET
Create loyalty program
POST
Update loyalty program
PATCH
Search loyalty ledger entries (paginated; optional per-user balance; CSV export)
GET
List loyalty tiers with user distribution counts
GET
Create loyalty tier
POST
Delete loyalty tier
DELETE
Update loyalty tier threshold / config
PATCH
Members
List project members
GET
Add an existing tenant user as a project member (project ADMIN)
POST
Change a project member's role (project ADMIN)
PUT
Remove a project member (project ADMIN)
DELETE
Metrics
List metric definitions
GET
Create a metric definition (draft)
POST
Get a metric definition with version history
GET
Update a draft metric definition
PUT
Publish a new immutable metric version (optionally trigger backfill)
POST
Roll back the active metric to a historical version
POST
Query the active metric value over a window
GET
Platform
List all tenants (SUPER_ADMIN)
GET
Create a tenant with a specified OWNER (SUPER_ADMIN)
POST
Update a tenant name / active flag (SUPER_ADMIN)
PUT
Cross-tenant read-only user search (SUPER_ADMIN)
GET
Grant/revoke a user's platform system role (SUPER_ADMIN)
PUT
Projects
List projects for the active tenant
GET
Create a project in the active tenant (tenant ADMIN)
POST
Get a project (ADMIN/OWNER also see apiKey/apiSecret)
GET
Update a project's name/description/domain (project ADMIN)
PUT
Delete a project (project OWNER)
DELETE
Regenerate the project's apiKey/apiSecret (project ADMIN)
POST
Tenants
Active tenant profile (min tenant ADMIN)
GET
Update active tenant name (min tenant ADMIN)
PATCH
Transfer tenant ownership (OWNER only)
POST
List members of the active tenant (min tenant ADMIN)
GET
Change a tenant member's role (ADMIN/MEMBER)
PUT
Remove a tenant member
DELETE
Change the caller's own password (self-service)
PUT
UserValue
Get published value definition (+ effective, defaults-merged)
GET
Upsert value definition (merged with defaults)
PUT
Delete value definition
DELETE
List user value snapshots (filterable, paginated)
GET
Get a single user value snapshot
GET
Value-users workspace summary
GET
List value-users operation queues
GET
List rows in a value-users operation queue
GET
List saved audiences
GET
Create a saved audience
POST
Get a saved audience
GET
Delete a saved audience
DELETE
Create an email campaign draft from a saved audience
POST
List value automation outbox events (sanitized)
GET
List value operation tasks (or inbound conversations when view=conversations)
GET
Complete a value operation task (thread-wide for inbound_reply_followup)
POST
Aggregate an inbound_reply_followup task's full conversation thread
GET
Send a system-internal reply on an inbound_reply_followup task's thread
POST
List value backfill jobs
GET
Create a value backfill job
POST
Get a value backfill job
GET
Resume a value backfill job (one window per run)
POST
Cancel a value backfill job
POST
List a backfill job's windows (paginated)
GET
Project-level value data-quality summary
GET
Per-user value data-quality summary + hints
GET
Users
Paginated user list with filters and operator tags (masked columns only)
GET
Distinct locale values (for filter dropdown)
GET
Equality search by email or phone (HMAC-hashed server-side)
POST
Streaming CSV export of the matched user set (masked columns only)
GET
User meta counts (visit/event counts from Analytics Engine)
GET
User overview (lifetime + 30-day activity, recent timeline)
GET
User visit history (cursor-paginated, from Analytics Engine)
GET
User event history (cursor-paginated, business-context enriched)
GET
User identity profile (masked PII, linked visitors, acquisition)
GET
User value profile (snapshot, AARRR, lifecycle, quality, trends)
GET
User email reach history (outbound events ∪ inbound messages, cursor-paginated)
GET
Read operator annotation (tags + note) for a user
GET
Upsert operator annotation (tags + note) for a user
PUT
Webhooks
List project webhooks (secrets redacted)
GET
Create a webhook
POST
Get a webhook (secret redacted)
GET
Delete a webhook
DELETE
Update a webhook (secret redacted in response)
PATCH
Regenerate a webhook's signing secret
POST
List recent webhook delivery attempts
GET
Send a test ping to a webhook
POST
Select theme
Dark
Light
Auto
Management
>
EventCatalog
List event definitions with usage (SUPER_ADMIN)
Authorizations
Section titled “Authorizations”
SessionCookie
Responses
Section titled “Responses”
200
Section titled “200”
{ events }
Media type
application/json
object
key
additional properties
any