Skip to main content
POST
Get the scroll map

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.
  • views counts only views that reported scroll data; all_views counts every view of the page, so the two differ when the SDK has not reported scroll for all of them.

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

Scope a heatmap query to one page, optionally at one viewport width and for one cohort.

application_id
string
required

RUM application ID. The caller needs read access to it.

page
string
required

Page path group the heatmap is about, e.g. /checkout. Required.

cohort
object

Restrict the heatmap to the units of one funnel transition. Omit for all traffic.

end_time
integer<int64>

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

Example:

1780358400000

max_width
integer

Exclusive upper bound on the viewport width: views narrower than max_width are included. 0 or omitted means no upper bound; it must be greater than min_width when both are set.

Required range: x >= 0
min_width
integer

Smallest viewport width in CSS pixels to include. 0 or omitted means no lower bound.

Required range: x >= 0
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

Scroll map of the page.