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.
/v1/projects/{project_id}/heatmaps/scroll-mapAuthorizations
Authorizationstringrequiredhttp
Path parameters
project_idstringrequiredAmplitude project identifier, backed by the canonical app ID.
12345pattern: ^[0-9]+$Body
application/jsonpage_urlstringrequiredPage 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.
https://example.com/pricingmin length: 1max length: 2048url_matchstringHow 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.
iscontainshas_prefixglobisdevice_typestringViewport 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.
desktoplaptoptabletmobilecustomdesktopviewport_widthintegerExact viewport width in pixels. Required when device_type is custom
and not accepted otherwise.
min: 1max: 20000time_rangeobjectShow child attributes
startstringrequiredInclusive start date (project timezone unless timezone is set on query).
format: dateendstringrequiredInclusive end date.
format: dateResponse
application/jsondataobjectrequiredScroll-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
idstringrequiredIdentifier for this computation.
objectstringrequiredResource-type discriminator. Always scroll_map.
project_idstringrequiredpattern: ^[0-9]+$page_urlstringrequiredThe page URL after normalization.
url_matchstringrequiredHow 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.
iscontainshas_prefixglobisdevice_typestringrequiredViewport 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.
desktoplaptoptabletmobilecustomdesktopviewport_widthintegerrequiredExact viewport width used when device_type is custom; otherwise null.
nullabletime_rangeobjectrequiredstartstringrequiredInclusive start date (project timezone unless timezone is set on query).
format: dateendstringrequiredInclusive end date.
format: datetimezonestringrequiredIANA timezone used to resolve time_range day boundaries (the project timezone).
total_sessionsintegerrequiredSessions with a scroll event on the page in the range (the first bucket's count).
min: 0average_fold_pxintegerrequiredAverage viewport height in pixels, or null when unavailable.
nullablemax_scroll_depth_pxintegerrequiredDeepest scroll position observed in page pixels, or null when unavailable.
nullablebucket_countintegerrequiredmin: 0bucketsobject[]requireddepth_from_pxintegerrequiredLower bound of the scroll-depth bucket in page pixels.
min: 0depth_to_pxintegerrequiredUpper bound of the scroll-depth bucket in page pixels.
min: 0sessions_reachedintegerrequiredSessions that scrolled at least to this bucket.
min: 0percent_reachednumberrequiredsessions_reached divided by the sessions counted in the first
bucket, as a fraction. The first bucket is always 1.
min: 0max: 1warningsstring[]requiredNon-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.