Explain a step's drop-off
curl --request POST \
--url 'https://api.flashcat.cloud/rum/funnel/drivers?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": [
"desktop"
]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"end_time": 1780358400000,
"from_step": 1,
"start_time": 1780272000000
}
'import requests
url = "https://api.flashcat.cloud/rum/funnel/drivers?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": ["desktop"]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"end_time": 1780358400000,
"from_step": 1,
"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',
definition: {
filters: [{field: 'device_type', values: ['desktop']}],
steps: [
{kind: 'page', label: 'Cart', page: {op: 'prefix', value: '/cart'}},
{event_id: 'n3Q8kZvT2mRxW7cLpYbE4a', kind: 'event', label: 'Checkout'},
{kind: 'page', label: 'Thank you', page: {op: 'eq', value: '/thank-you'}}
],
unit: 'session'
},
end_time: 1780358400000,
from_step: 1,
start_time: 1780272000000
})
};
fetch('https://api.flashcat.cloud/rum/funnel/drivers?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/funnel/drivers?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',
'definition' => [
'filters' => [
[
'field' => 'device_type',
'values' => [
'desktop'
]
]
],
'steps' => [
[
'kind' => 'page',
'label' => 'Cart',
'page' => [
'op' => 'prefix',
'value' => '/cart'
]
],
[
'event_id' => 'n3Q8kZvT2mRxW7cLpYbE4a',
'kind' => 'event',
'label' => 'Checkout'
],
[
'kind' => 'page',
'label' => 'Thank you',
'page' => [
'op' => 'eq',
'value' => '/thank-you'
]
]
],
'unit' => 'session'
],
'end_time' => 1780358400000,
'from_step' => 1,
'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/funnel/drivers?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"end_time\": 1780358400000,\n \"from_step\": 1,\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/funnel/drivers?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"end_time\": 1780358400000,\n \"from_step\": 1,\n \"start_time\": 1780272000000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/funnel/drivers?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 \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"end_time\": 1780358400000,\n \"from_step\": 1,\n \"start_time\": 1780272000000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"converted": 3184,
"factors": [
{
"diff": -57.2,
"hit": 812,
"hit_rate": 21.4,
"issue_first_seen_version": "2.14.0",
"issue_status": "unresolved",
"key": "01JQ7M2X4B9K3TD6V8WY5A1C0E",
"kind": "error",
"label": "TypeError: Cannot read properties of undefined (reading 'total')",
"low_sample": false,
"miss": 2372,
"miss_rate": 78.6,
"sample_session": "0a4a2e64-8a4f-4b9a-9c1e-3a2f9e6d7c81"
}
],
"flow": [
{
"count": 912,
"from": "",
"level": 1,
"to": "/cart/shipping"
},
{
"count": 631,
"from": "",
"level": 1,
"to": ""
}
],
"from_step": 1,
"next_pages": [
{
"count": 912,
"page": "/cart/shipping"
},
{
"count": 631,
"page": ""
}
],
"reached": 5120,
"sessions": [
{
"duration_ms": 184000,
"factors": [
"error",
"slow_api"
],
"has_replay": true,
"session_id": "0a4a2e64-8a4f-4b9a-9c1e-3a2f9e6d7c81",
"views": 9
}
]
},
"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"
}Funnels
Explain a step's drop-off
Explain why units dropped between one funnel step and the next: factors, next pages, paths and example sessions.
POST
/
rum
/
funnel
/
drivers
Explain a step's drop-off
curl --request POST \
--url 'https://api.flashcat.cloud/rum/funnel/drivers?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": [
"desktop"
]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"end_time": 1780358400000,
"from_step": 1,
"start_time": 1780272000000
}
'import requests
url = "https://api.flashcat.cloud/rum/funnel/drivers?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"definition": {
"filters": [
{
"field": "device_type",
"values": ["desktop"]
}
],
"steps": [
{
"kind": "page",
"label": "Cart",
"page": {
"op": "prefix",
"value": "/cart"
}
},
{
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"kind": "event",
"label": "Checkout"
},
{
"kind": "page",
"label": "Thank you",
"page": {
"op": "eq",
"value": "/thank-you"
}
}
],
"unit": "session"
},
"end_time": 1780358400000,
"from_step": 1,
"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',
definition: {
filters: [{field: 'device_type', values: ['desktop']}],
steps: [
{kind: 'page', label: 'Cart', page: {op: 'prefix', value: '/cart'}},
{event_id: 'n3Q8kZvT2mRxW7cLpYbE4a', kind: 'event', label: 'Checkout'},
{kind: 'page', label: 'Thank you', page: {op: 'eq', value: '/thank-you'}}
],
unit: 'session'
},
end_time: 1780358400000,
from_step: 1,
start_time: 1780272000000
})
};
fetch('https://api.flashcat.cloud/rum/funnel/drivers?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/funnel/drivers?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',
'definition' => [
'filters' => [
[
'field' => 'device_type',
'values' => [
'desktop'
]
]
],
'steps' => [
[
'kind' => 'page',
'label' => 'Cart',
'page' => [
'op' => 'prefix',
'value' => '/cart'
]
],
[
'event_id' => 'n3Q8kZvT2mRxW7cLpYbE4a',
'kind' => 'event',
'label' => 'Checkout'
],
[
'kind' => 'page',
'label' => 'Thank you',
'page' => [
'op' => 'eq',
'value' => '/thank-you'
]
]
],
'unit' => 'session'
],
'end_time' => 1780358400000,
'from_step' => 1,
'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/funnel/drivers?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"end_time\": 1780358400000,\n \"from_step\": 1,\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/funnel/drivers?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"end_time\": 1780358400000,\n \"from_step\": 1,\n \"start_time\": 1780272000000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/funnel/drivers?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 \"definition\": {\n \"filters\": [\n {\n \"field\": \"device_type\",\n \"values\": [\n \"desktop\"\n ]\n }\n ],\n \"steps\": [\n {\n \"kind\": \"page\",\n \"label\": \"Cart\",\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/cart\"\n }\n },\n {\n \"event_id\": \"n3Q8kZvT2mRxW7cLpYbE4a\",\n \"kind\": \"event\",\n \"label\": \"Checkout\"\n },\n {\n \"kind\": \"page\",\n \"label\": \"Thank you\",\n \"page\": {\n \"op\": \"eq\",\n \"value\": \"/thank-you\"\n }\n }\n ],\n \"unit\": \"session\"\n },\n \"end_time\": 1780358400000,\n \"from_step\": 1,\n \"start_time\": 1780272000000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"converted": 3184,
"factors": [
{
"diff": -57.2,
"hit": 812,
"hit_rate": 21.4,
"issue_first_seen_version": "2.14.0",
"issue_status": "unresolved",
"key": "01JQ7M2X4B9K3TD6V8WY5A1C0E",
"kind": "error",
"label": "TypeError: Cannot read properties of undefined (reading 'total')",
"low_sample": false,
"miss": 2372,
"miss_rate": 78.6,
"sample_session": "0a4a2e64-8a4f-4b9a-9c1e-3a2f9e6d7c81"
}
],
"flow": [
{
"count": 912,
"from": "",
"level": 1,
"to": "/cart/shipping"
},
{
"count": 631,
"from": "",
"level": 1,
"to": ""
}
],
"from_step": 1,
"next_pages": [
{
"count": 912,
"page": "/cart/shipping"
},
{
"count": 631,
"page": ""
}
],
"reached": 5120,
"sessions": [
{
"duration_ms": 184000,
"factors": [
"error",
"slow_api"
],
"has_replay": true,
"session_id": "0a4a2e64-8a4f-4b9a-9c1e-3a2f9e6d7c81",
"views": 9
}
]
},
"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. from_stepis 1-based and must have a following step.- Factors are ranked by how much they separate converted from dropped units;
low_sample=truemarks a factor with too few units to be conclusive. - In
flow, an emptytomeans the units left the site and*means they went to pages outside that hop’s top few.
Authorizations
Body
application/json
Explain the drop between one funnel step and the next.
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?