Skip to main content
GET
Per-agent journey funnels

Authorizations

X-API-Key
string
header
required

API key for programmatic access. Keys use the format nl_live_<64 hex> or nl_test_<64 hex> and are scoped to an account's RBAC permissions.

Query Parameters

range
enum<string>
default:30d

Shorthand window ending now. Ignored when from or to is given.

Available options:
7d,
30d,
90d
from
string<date-time>

Inclusive start of the window (ISO-8601 timestamp).

to
string<date-time>

Exclusive end of the window (ISO-8601 timestamp). Defaults to now. The window may span at most 366 days.

tz
string

IANA timezone used to bucket /daily. Unknown values fall back to UTC.

Example:

"Asia/Jerusalem"

Response

Agent funnels

agents
object[]
required