API Documentation

Send tracking events. Record logins, page views, and custom events.

Merge anonymous user with identified user. Reassigns all historical events.

Record client-side errors as page_error events.

List all accounts with usage stats. Supports global filters.

Detailed account info: summary stats, users, properties, owner, external ID.

Update firmographic properties (industry, company_size, segment, revenue_range).

Assign CS owner.

Top 10 users by activity for this account.

Daily activity trend (users + events) for one account.

Health score history with signal change events.

Add a note to an account.

Delete an account note.

Accounts with declining activity vs prior period.

Per-account usage for specified features.

Distinct values for each firmographic field. Used for filter dropdowns.

User detail with event history, account, and properties.

Update user attributes (first_name, last_name, external_id, custom properties).

List notes for a user.

Add a note to a user.

Delete a user note.

Daily activity trend for one user.

Top 10 users by event count. Supports global filters.

Daily breakdown of new vs returning users.

Monthly unique user counts.

All event types with counts. Default 90-day window.

Property keys and sample values for an event type.

Flexible query with include/exclude conditions and property filters.

Correlation: users who do X are Nx more likely to do Y.

All tracked pages with view counts.

Daily active users and total events. Supports global filters.

Users active in last 5 minutes with sparkline.

Session-based path analysis with drop-off points.

Sequential funnel with step-to-step conversion.

Same funnel across different segments.

Cohort-based retention analysis.

Feature adoption rates for all event types.

Detailed adoption for one feature with daily trend.

Compare up to 4 features side by side.

Daily trend for an event with optional property breakdown.

List all segments.

Create a segment with combinable rules.

Segment detail with resolved user list.

Update segment name, rules, or folder.

Delete a segment.

Estimate segment size before saving.

Compare two segments: overlap and behavioral diff.

List all segment folders.

Create a folder.

Paginated signals feed.

Summary stats with category counts.

Prioritized daily focus list.

Record an action taken. Starts Impact tracking.

Dismiss a signal.

5-component account health scores (Activity, Breadth, Depth, Trend, Recency).

Health score detail for a specific account.

Closed-loop overview: actions taken, outcomes, headline ROI stats.

Actions with outcomes (pending, resolved, unresolved).

Manually resolve or unresolve an action.

CSV export of all actions with outcomes.

Natural language query to Ask Prody. Returns AI analysis backed by your data.

Behavioral patterns predicting success.

Summary: total active, new, highest lift, pinned count.

Update status or pin state.

List configured success events for discovery analysis.

Add a success event (max 3).

Remove a success event definition.

List all journeys with latest metrics and recommendation counts.

Journey detail with 30 days of snapshots and AI recommendations.

Live funnel computation (not from nightly snapshot).

Users stuck between two journey steps.

Create a journey (2-8 steps). Plan limits apply.

Update name, steps, window, or status. Admin only.

Delete journey, snapshots, and recommendations.

Act on a recommendation. Logs to Impact tracking.

Dismiss a recommendation.

List all nudges with stats and audience info.

Single nudge with full config, stats, and target users.

Create a nudge.

Update nudge config. Recalculates audience_type.

Activate. Returns conflict warnings for same-page nudges.

Pause. Auto-resolves linked recovery signals.

Delete nudge and audience log.

Track impression/click/dismiss from tracker.js.

AI generates nudge copy from journey context.

Audience flow: entered, shown, clicked, dismissed, progressed.

Aggregate nudge impact for Results page.

Trigger dynamic audience refresh. Admin only.

List all products the user has access to.

Create a new isolated product.

Rename a product.

Delete a product. Cannot delete active product.

Switch active product. Re-issues session.

Monthly tracked users across all products with daily breakdown.

Data stats: total events, users, accounts, event types.

Set data retention policy.

Bulk delete events by type or date.

Rename event type across all events.

Merge two event types.

Archive or restore event type.

List properties for an event type.

Rename a property key.

Merge two property keys.

Property metadata (status, description).

Update property metadata.

All PII data for a user (DSAR compliance).

Anonymize user: replace email with hash, clear properties.

Export all user data as CSV.

Bulk update account metadata.

Import account metadata from CSV (5K row limit).

Bulk update user metadata.

Import user metadata from CSV (5K row limit).

Get tenant settings.

Update settings. Admin only.

Get custom event labels.

Save custom labels.

List all threshold alerts.

Create a threshold alert.

List goals with progress.

Create a measurable goal.

List saved views.

Export data as CSV.