Query scroll map

이 페이지는 아직 귀하의 언어로 번역되지 않았습니다. 현재 작업 중이므로 곧 다시 확인해 주십시오.

Returns the scroll-depth distribution for one page URL as a cumulative
histogram from the top of the page, plus the average fold and the deepest
scroll observed. Filter by device viewport band and date range. Results
reflect the authenticated caller's project access and data access
controls.

This POST computes a result and does not mutate state. It is therefore a
read operation and does not require an Idempotency-Key.

Omitting time_range uses the last 30 days in the project timezone. The
span of time_range cannot exceed 90 days.

post/v1/projects/{project_id}/heatmaps/scroll-map

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$

Body

application/json
page_urlstringrequired

Page URL to analyze. Accepts http and https URLs; a URL without a scheme is treated as https. The query string and fragment are removed before matching, so https://example.com/pricing?utm=x and https://example.com/pricing are the same page.

Example:https://example.com/pricing
Constraints:min length: 1max length: 2048
url_matchstring

How page_url is matched against the page URL recorded on each event. is matches the exact URL, contains matches any URL containing it, has_prefix matches URLs starting with it, and glob treats * as a wildcard.

Allowed values:iscontainshas_prefixglob
Default:is
device_typestring

Viewport band to include, matching the device selector in the product: desktop is at least 1440 px wide, laptop is 900 to 1440 px, tablet is 500 to 900 px, mobile is at most 500 px. Use custom with viewport_width to match one exact width.

Allowed values:desktoplaptoptabletmobilecustom
Default:desktop
viewport_widthinteger

Exact viewport width in pixels. Required when device_type is custom and not accepted otherwise.

Constraints:min: 1max: 20000
time_rangeobject
Show child attributes
startstringrequired

Inclusive start date (project timezone unless timezone is set on query).

Constraints:format: date
endstringrequired

Inclusive end date.

Constraints:format: date

Response

application/json
200· Scroll map computed successfully.
dataobjectrequired

Scroll-depth distribution for one page, as a cumulative histogram from the top of the page. All buckets are returned in page order. Results reflect the caller's data access.

Show child attributes
idstringrequired

Identifier for this computation.

objectstringrequired

Resource-type discriminator. Always scroll_map.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
page_urlstringrequired

The page URL after normalization.

url_matchstringrequired

How page_url is matched against the page URL recorded on each event. is matches the exact URL, contains matches any URL containing it, has_prefix matches URLs starting with it, and glob treats * as a wildcard.

Allowed values:iscontainshas_prefixglob
Default:is
device_typestringrequired

Viewport band to include, matching the device selector in the product: desktop is at least 1440 px wide, laptop is 900 to 1440 px, tablet is 500 to 900 px, mobile is at most 500 px. Use custom with viewport_width to match one exact width.

Allowed values:desktoplaptoptabletmobilecustom
Default:desktop
viewport_widthintegerrequired

Exact viewport width used when device_type is custom; otherwise null.

Constraints:nullable
time_rangeobjectrequired
startstringrequired

Inclusive start date (project timezone unless timezone is set on query).

Constraints:format: date
endstringrequired

Inclusive end date.

Constraints:format: date
timezonestringrequired

IANA timezone used to resolve time_range day boundaries (the project timezone).

total_sessionsintegerrequired

Sessions with a scroll event on the page in the range (the first bucket's count).

Constraints:min: 0
average_fold_pxintegerrequired

Average viewport height in pixels, or null when unavailable.

Constraints:nullable
max_scroll_depth_pxintegerrequired

Deepest scroll position observed in page pixels, or null when unavailable.

Constraints:nullable
bucket_countintegerrequired
Constraints:min: 0
bucketsobject[]required
depth_from_pxintegerrequired

Lower bound of the scroll-depth bucket in page pixels.

Constraints:min: 0
depth_to_pxintegerrequired

Upper bound of the scroll-depth bucket in page pixels.

Constraints:min: 0
sessions_reachedintegerrequired

Sessions that scrolled at least to this bucket.

Constraints:min: 0
percent_reachednumberrequired

sessions_reached divided by the sessions counted in the first bucket, as a fraction. The first bucket is always 1.

Constraints:min: 0max: 1
warningsstring[]required

Non-fatal conditions, such as an empty result for the range.

이 내용이 도움이 되었나요?

For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.