Read the journey funnel
method
GET
host
strait.
version
/v1
resource
/
GET /v1/funnel
Auth: secret key as Authorization: Bearer. Server-side only.
Request
Of the people who tapped your links in [from, to), how many (1) tapped (clicked), (2) reached your app or the App Store / Play Store, (3) opened the app (already had it, or installed it and opened it), and (4) reached the screen the link points to, split by platform, with the exits before step 2 (a computer, the website on a phone, stuck in an in-app browser, not tracked) and the drop-offs between steps (with reasons). Each person counts at a step only if they counted at every step before it, and is counted by their tap time. Step 1 equals GET /v1/analytics taps and the dashboard's first step; step 4 its "reached the screen". What we cannot see: whether the store page loaded (step 2 means we sent them there), installs never opened, and whether your app drew the screen (step 4 means the app received the exact link). iPhone installs matched by device signals are certainty.estimated. Secret key (full or read access); at most 92 days per call and 30 calls a minute per workspace (429 with Retry-After).
Parameters
fromstring query- Inclusive start: ISO date (UTC), ISO date-time or epoch ms. Default: 30 days before
to. tostring query- Exclusive end, same formats. Default: now.
tzstring query- IANA time zone the range was chosen in (echoed in
range.tz). Default UTC. link_idstring query- Only this link: its id (also a paused link) or its active slug.
campaignstring query- Only this campaign (the link's, else the tap's);
(no campaign)for none. channelstring query- Only this channel (whatsapp, instagram, …);
directfor none. compare"0" | "1" query- 1: also return
previous, the same numbers for the period of equal length just before.
Response
- 200 The funnel
- 400 Bad from / to (or a range over 92 days), tz, link_id, campaign, channel or compare
- 401 Missing or invalid secret key, or a publishable key
- 403 The key is limited to links
- 404 No link with this id or slug in the key's workspace
- 429 Over 30 calls a minute for this workspace
curl -X GET https://strait.link/v1/funnel \
-H "Authorization: Bearer $SECRET_KEY"const res = await fetch('https://strait.link/v1/funnel', {
headers: { Authorization: `Bearer ${process.env.SECRET_KEY}` },
});
const data = await res.json();
console.log(res.status, data);import os
import requests
res = requests.get(
"https://strait.link/v1/funnel",
headers={"Authorization": f"Bearer {os.environ['SECRET_KEY']}"},
)
print(res.status_code, res.json())<?php
// Plain PHP with ext-curl, no packages. In Laravel, Http::withToken($secretKey)->get($url) sends the same request.
$ch = curl_init('https://strait.link/v1/funnel');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('SECRET_KEY'),
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status, PHP_EOL;
print_r(json_decode($response, true));import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
// Java 17+, java.net.http only (no dependencies).
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://strait.link/v1/funnel"))
.header("Authorization", "Bearer " + System.getenv("SECRET_KEY"))
.GET()
.build();
HttpResponse<String> res = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(res.statusCode() + " " + res.body());
}
}package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://strait.link/v1/funnel", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("SECRET_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
log.Fatal(err)
}
fmt.Println(res.StatusCode, string(data))
}The response, printed
{
"range": {
"from": "2026-10-31T18:30:00.000Z",
"to": "2026-11-07T18:30:00.000Z",
"tz": "Asia/Kolkata",
"clamped_from": null
},
"link_id": null,
"steps": [
{
"key": "clicked",
"count": 4859,
"by_platform": {
"android": 1492,
"ios": 758,
"desktop": 2609,
"other": 0
}
},
{
"key": "app_or_store",
"count": 1210,
"by_platform": {
"android": 1101,
"ios": 109,
"desktop": 0,
"other": 0
}
},
{
"key": "opened_app",
"count": 701,
"by_platform": {
"android": 598,
"ios": 103,
"desktop": 0,
"other": 0
},
"split": {
"had_app": 452,
"installed": 249
}
},
{
"key": "reached_screen",
"count": 687,
"by_platform": {
"android": 590,
"ios": 97,
"desktop": 0,
"other": 0
},
"certainty": {
"exact": 590,
"estimated": 97
}
}
],
"phone_clicks": 2250,
"exits": [
{
"key": "computer",
"count": 2609
},
{
"key": "phone_website",
"count": 468
},
{
"key": "in_app_browser",
"count": 567
},
{
"key": "other",
"count": 5
}
],
"drops": [
{
"after": "app_or_store",
"key": "store_no_open",
"count": 509,
"by_platform": {
"android": 503,
"ios": 6,
"desktop": 0,
"other": 0
}
},
{
"after": "opened_app",
"key": "open_failed",
"count": 14,
"by_platform": {
"android": 8,
"ios": 6,
"desktop": 0,
"other": 0
},
"reasons": [
[
"expired",
6
],
[
"not_found",
4
],
[
"network",
4
]
]
}
],
"untied_failed_opens": {
"count": 10,
"by_platform": {
"android": 10,
"ios": 0,
"desktop": 0,
"other": 0
},
"reasons": [
[
"expired",
6
],
[
"not_found",
4
]
]
},
"installs": {
"total": 312,
"credited": 30,
"tied_to_click": 17,
"tied_exact": 13,
"tied_estimated": 4,
"estimated_from_earlier_clicks": 0,
"from_period_clicks": 17,
"from_earlier_clicks": 0,
"from_link_no_click": 13,
"organic": 282,
"exact": 14,
"estimated": 16,
"click_to_install": {
"median_ms": 4920,
"n": 7,
"first_open_from_link": 10
},
"by_platform": {
"android": {
"credited": 13,
"tied_to_click": 13,
"from_period_clicks": 13,
"from_earlier_clicks": 0,
"from_link_no_click": 0,
"organic": 11,
"exact": 13,
"estimated": 0
},
"ios": {
"credited": 16,
"tied_to_click": 4,
"from_period_clicks": 4,
"from_earlier_clicks": 0,
"from_link_no_click": 12,
"organic": 266,
"exact": 0,
"estimated": 16
},
"other": {
"credited": 1,
"tied_to_click": 0,
"from_period_clicks": 0,
"from_earlier_clicks": 0,
"from_link_no_click": 1,
"organic": 5,
"exact": 1,
"estimated": 0
}
}
},
"revenue": {
"INR": 1996,
"USD": 346.97
},
"days": [
{
"day": "2026-11-01",
"clicked": 702,
"reached_screen": 101
},
{
"day": "2026-11-02",
"clicked": 688,
"reached_screen": 97
}
],
"did_something": 196,
"unmatched_first_opens": 196,
"installs_without_click": 0,
"expired_taps": 1,
"match_certainty": {
"installs": {
"of": "credited_installs",
"total": 30,
"exact": 14,
"estimated": 16
},
"reached_screen": {
"of": "clicks_reached_screen",
"total": 687,
"exact": 590,
"estimated": 97
}
},
"test_data_left_out": {
"clicks": 0,
"installs": 0
},
"website_opens": 0,
"previous": null,
"plan": {
"id": "starter",
"history_days": null,
"locked": []
}
}