Get the heatmap background frame
curl --request POST \
--url 'https://api.flashcat.cloud/rum/heatmap/background?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"end_time": 1780358400000,
"page": "/checkout",
"start_time": 1780272000000
}
'import requests
url = "https://api.flashcat.cloud/rum/heatmap/background?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"end_time": 1780358400000,
"page": "/checkout",
"start_time": 1780272000000
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: 'app_3fK9mQ2xLp7VbN4cR8dW1y',
end_time: 1780358400000,
page: '/checkout',
start_time: 1780272000000
})
};
fetch('https://api.flashcat.cloud/rum/heatmap/background?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/rum/heatmap/background?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => 'app_3fK9mQ2xLp7VbN4cR8dW1y',
'end_time' => 1780358400000,
'page' => '/checkout',
'start_time' => 1780272000000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/rum/heatmap/background?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"end_time\": 1780358400000,\n \"page\": \"/checkout\",\n \"start_time\": 1780272000000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/heatmap/background?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"end_time\": 1780358400000,\n \"page\": \"/checkout\",\n \"start_time\": 1780272000000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/heatmap/background?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"end_time\": 1780358400000,\n \"page\": \"/checkout\",\n \"start_time\": 1780272000000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"background": {
"frame_time": 1780340150000,
"session_id": "0a4a2e64-8a4f-4b9a-9c1e-3a2f9e6d7c81",
"start_time": 1780340000000,
"view_id": "b8e2f1a4-6c93-4d07-8b52-1a9f7c3e60d5",
"viewport_height": 900,
"viewport_width": 1440
}
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "AccessDenied",
"message": "Access Denied."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}Heatmaps
Get the heatmap background frame
Find a replay frame that opens with a full snapshot of the page, to render behind the heatmap.
POST
/
rum
/
heatmap
/
background
Get the heatmap background frame
curl --request POST \
--url 'https://api.flashcat.cloud/rum/heatmap/background?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"end_time": 1780358400000,
"page": "/checkout",
"start_time": 1780272000000
}
'import requests
url = "https://api.flashcat.cloud/rum/heatmap/background?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"end_time": 1780358400000,
"page": "/checkout",
"start_time": 1780272000000
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: 'app_3fK9mQ2xLp7VbN4cR8dW1y',
end_time: 1780358400000,
page: '/checkout',
start_time: 1780272000000
})
};
fetch('https://api.flashcat.cloud/rum/heatmap/background?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/rum/heatmap/background?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => 'app_3fK9mQ2xLp7VbN4cR8dW1y',
'end_time' => 1780358400000,
'page' => '/checkout',
'start_time' => 1780272000000
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/rum/heatmap/background?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"end_time\": 1780358400000,\n \"page\": \"/checkout\",\n \"start_time\": 1780272000000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/heatmap/background?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"end_time\": 1780358400000,\n \"page\": \"/checkout\",\n \"start_time\": 1780272000000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/heatmap/background?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"end_time\": 1780358400000,\n \"page\": \"/checkout\",\n \"start_time\": 1780272000000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"background": {
"frame_time": 1780340150000,
"session_id": "0a4a2e64-8a4f-4b9a-9c1e-3a2f9e6d7c81",
"start_time": 1780340000000,
"view_id": "b8e2f1a4-6c93-4d07-8b52-1a9f7c3e60d5",
"viewport_height": 900,
"viewport_width": 1440
}
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "AccessDenied",
"message": "Access Denied."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 200 requests/minute; 10 requests/second per account |
| Permissions | None — any valid app_key can call this operation |
Usage
start_timeandend_timeare Unix epoch milliseconds. Omit both to use the last 7 days; a range wider than 14 days returnsInvalidParameter.- The caller needs read access to
application_id; data of private applications the caller cannot access is not counted. backgroundisnullwhen the page has no replay in the scope.frame_timeis the last click in that view, so the clicked elements exist in the frame; it falls back to the snapshot time when there is no click.
Authorizations
Body
application/json
Scope a heatmap query to one page, optionally at one viewport width and for one cohort.
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.
Was this page helpful?