Scroll-depth curve for one page
How many sessions still had eyes on each band of the page, cumulative from the deepest band upward — so sessions_reached reads "at least this far down".
Depth is max scroll y + viewport height, because a visitor who never scrolled still saw one viewport. That makes the depth_px: 0 band equal to every measured session, i.e. the denominator.
One measurement per session per page, taken when the visitor leaves the page. Sessions whose final beacon never landed are absent: this is a curve over sessions we measured, not over all pageviews.
curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/data/heatmap/scroll?location_id=example_string&url=acme.com%2Fpricing&date_from=2024-12-25T10%3A00%3A00Z&date_to=2024-12-25T10%3A00%3A00Z&viewport_min=42&viewport_max=42&band=100&device_type=mobile&utm_source=facebook&utm_medium=cpc&utm_campaign=example_string&country=USA&segment_id=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/data/heatmap/scroll?location_id=example_string&url=acme.com%2Fpricing&date_from=2024-12-25T10%3A00%3A00Z&date_to=2024-12-25T10%3A00%3A00Z&viewport_min=42&viewport_max=42&band=100&device_type=mobile&utm_source=facebook&utm_medium=cpc&utm_campaign=example_string&country=USA&segment_id=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/data/heatmap/scroll?location_id=example_string&url=acme.com%2Fpricing&date_from=2024-12-25T10%3A00%3A00Z&date_to=2024-12-25T10%3A00%3A00Z&viewport_min=42&viewport_max=42&band=100&device_type=mobile&utm_source=facebook&utm_medium=cpc&utm_campaign=example_string&country=USA&segment_id=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://mythic-analytics.gulp.workers.dev/client/v1/data/heatmap/scroll?location_id=example_string&url=acme.com%2Fpricing&date_from=2024-12-25T10%3A00%3A00Z&date_to=2024-12-25T10%3A00%3A00Z&viewport_min=42&viewport_max=42&band=100&device_type=mobile&utm_source=facebook&utm_medium=cpc&utm_campaign=example_string&country=USA&segment_id=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/data/heatmap/scroll?location_id=example_string&url=acme.com%2Fpricing&date_from=2024-12-25T10%3A00%3A00Z&date_to=2024-12-25T10%3A00%3A00Z&viewport_min=42&viewport_max=42&band=100&device_type=mobile&utm_source=facebook&utm_medium=cpc&utm_campaign=example_string&country=USA&segment_id=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"page": "acme.com/pricing",
"band": 100,
"sessions": 1204,
"page_height": 5200,
"bands": [
{
"depth_px": 2000,
"sessions_reached": 602,
"sessions_total": 1204,
"reached_pct": 0.5,
"page_height": 5200
}
]
}
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
/client/v1/data/heatmap/scroll
Target server for requests. Edit to use your own host.
Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need heatmaps:read. See Using an mcp_ key over HTTP.
ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need heatmaps:read. See Using an mcp_ key over HTTP.Required with an agency key (ak_); ignored with a location key (sk_). Can also be sent as the X-Location-Id header.
Band height in px.
Session device — mobile, desktop, tablet. Resolved against the same session data /data/sessions reports, so the two agree.
Session source. Includes the referrer fallback: an untagged but referred session reads as google.com, not blank.
Stored segment. Scopes to sessions whose visitor is a member; membership resolves through the identity graph, so a person-level segment catches rows captured under any identity they used.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need heatmaps:read. See Using an mcp_ key over HTTP.
Query Parameters
Required with an agency key (ak_); ignored with a location key (sk_). Can also be sent as the X-Location-Id header.
acme.com/pricingBand height in px.
Session device — mobile, desktop, tablet. Resolved against the same session data /data/sessions reports, so the two agree.
mobileSession source. Includes the referrer fallback: an untagged but referred session reads as google.com, not blank.
facebookcpcStored segment. Scopes to sessions whose visitor is a member; membership resolves through the identity graph, so a person-level segment catches rows captured under any identity they used.