Skip to main content
POST
Query the page path flow

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.
  • direction is after or before; before needs start because a session has nothing before its entry.
  • depth is 2 to 5 distinct pages and defaults to 3.
  • With direction=after an empty to means the session left the site; with before it means the session began there.
  • sessions and the counts are scaled up when sample_rate is below 1.

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

Query the page flow around a page, or from the session's entry.

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
depth
integer
default:3

How many distinct pages to follow. 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. Omit for no filtering.

start
string

Page path group to follow. Omit to follow the session's entry; direction=before requires it.

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

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

How sessions moved around a page, as links for a flow chart.