In-app
Get In-App Step Stats
Engagement counts for one in-app sequence step
GET
/
api
/
v1
/
in-app
/
steps
/
{stepId}
/
stats
Get In-App Step Stats
curl --request GET \
--url https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats', 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.sequenzy.com/api/v1/in-app/steps/{stepId}/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"stepId": "node_321",
"sequenceId": "seq_789",
"stats": {
"created": 1240,
"displayed": 1012,
"clicked": 187,
"dismissed": 640
}
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: sequences:read"
}
{
"error": "In-app step not found"
}
Returns how many contacts got an item from an in-app sequence step, and how many of those items were displayed, clicked and dismissed (each counted once per item). Displayed, clicked and dismissed depend on your app reporting events. Requires the
sequences:read scope.
Request
string
required
The step’s node ID from Get Sequence.
curl "https://api.sequenzy.com/api/v1/in-app/steps/node_321/stats" \
--header "Authorization: Bearer $SEQUENZY_API_KEY"
{
"success": true,
"stepId": "node_321",
"sequenceId": "seq_789",
"stats": {
"created": 1240,
"displayed": 1012,
"clicked": 187,
"dismissed": 640
}
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: sequences:read"
}
{
"error": "In-app step not found"
}
⌘I
Get In-App Step Stats
curl --request GET \
--url https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats', 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.sequenzy.com/api/v1/in-app/steps/{stepId}/stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/in-app/steps/{stepId}/stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"stepId": "node_321",
"sequenceId": "seq_789",
"stats": {
"created": 1240,
"displayed": 1012,
"clicked": 187,
"dismissed": 640
}
}
{
"error": "Invalid API key"
}
{
"error": "API key is missing required scope: sequences:read"
}
{
"error": "In-app step not found"
}