API Reference

Base URL: https://api.prodlytix.com/v1

Authentication

All API requests require a bearer token in the Authorization header. Find your API key in Settings → API Keys. Use a plx_live_ key for production and a plx_test_ key for development and staging environments. Test-environment events are not counted toward your monthly event volume.

Authentication example

$ curl https://api.prodlytix.com/v1/events \
  -H "Authorization: Bearer plx_live_yourApiKey" \
  -H "Content-Type: application/json"

Event Ingestion

POST /events

Send a single behavioral event for a user.

POST /events

{
  "user_id": "usr_abc123",
  "event": "export_created",
  "timestamp": "2026-01-15T14:22:00Z",
  "properties": {
    "format": "csv",
    "row_count": 1450
  }
}

POST /events/batch

Send up to 500 events in a single request. Recommended for server-side usage.

POST /events/batch

{
  "events": [
    { "user_id": "usr_abc", "event": "dashboard_viewed" },
    { "user_id": "usr_def", "event": "filter_applied" }
  ]
}

User Identify

POST /identify

Set or update a user's traits. These traits are used to segment behavioral cohorts.

POST /identify

{
  "user_id": "usr_abc123",
  "traits": {
    "email": "[email protected]",
    "plan": "growth",
    "signup_date": "2025-11-03"
  }
}

Auto-Discovery

GET /auto-discovery/results

Retrieve the latest auto-discovery results for your workspace, including the top retention sequences ranked by predictive power.

Auto-discovery runs automatically (daily on Growth, real-time on Scale). You can also trigger a manual run via POST /auto-discovery/trigger.

Funnels

POST /funnels/query

Query a funnel conversion rate for a specific event sequence, date range, and optional cohort filter.

Cohorts

GET /cohorts — List all defined cohorts in the workspace.

POST /cohorts — Create a new behavioral cohort definition. Cohorts are defined by event conditions, event sequences, or user property filters.

GET /cohorts/{id}/members — Retrieve the list of user IDs in a cohort. Paginated; returns up to 500 user IDs per page.

Rate Limits

The event ingestion endpoint (/events and /events/batch) accepts up to 1,000 requests per second per workspace on the Scale plan. Growth and Starter plans are rate-limited to 100 requests per second. All other endpoints are rate-limited to 60 requests per minute. Rate-limited requests return HTTP 429 with a Retry-After header.