Skip to main content
POST
List sessions of a path flow node

Restrictions

Usage

  • start_time and end_time are Unix epoch milliseconds. Omit both to use the last 7 days; a range wider than 14 days returns InvalidParameter.
  • The caller needs read access to application_id; data of private applications the caller cannot access is not counted.
  • level picks the hop of the flow: 0 is the start page itself; to names the page at that level and from, when set, the page at the previous one.
  • from and to accept an empty string, which is a real value: the session’s entry, or that it left.
  • At most 20 sessions are returned.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

List example sessions of one node or band of a page flow.

application_id
string
required

RUM application ID. The caller needs read access to it; for write operations, manage access.

direction
enum<string>
required

Direction along the session: after follows the pages viewed after the start, before the pages viewed before it.

Available options:
after,
before
level
integer
required

Level of the flow the sessions come from; 0 is the start page itself, whose sessions all reached it.

Required range: x >= 0
depth
integer
default:3

Depth the flow was queried with. 2-5, default 3.

Required range: 2 <= x <= 5
end_time
integer<int64>

End of the window, Unix timestamp in milliseconds. Defaults to now when omitted.

Example:

1780358400000

filters
object[]

Filters applied to the views the flow is built from.

from
string | null

Page path group at the previous level, to pick one band of the flow. Not checked at level 1; an empty string is a real value (the session's entry, or that it left).

start
string

Page path group the flow was built from. Omit to follow the session's entry.

start_time
integer<int64>

Start of the window, Unix timestamp in milliseconds. Omit both bounds to use the last 7 days; a range wider than 14 days is rejected.

Example:

1780272000000

to
string | null

Page path group at level. Omit to describe the node whatever the session came from; an empty string is a real value.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Example sessions of one node or band of a page flow, most recent first.