Get engagement summary
curl --request GET \
--url https://api.craftkit.dev/v1/renders/{id}/engagement \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.craftkit.dev/v1/renders/{id}/engagement"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.craftkit.dev/v1/renders/{id}/engagement', 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.craftkit.dev/v1/renders/{id}/engagement",
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.craftkit.dev/v1/renders/{id}/engagement"
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.craftkit.dev/v1/renders/{id}/engagement")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.craftkit.dev/v1/renders/{id}/engagement")
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{
"counts": {
"viewed": 12,
"downloaded": 3,
"printed": 0,
"email_opened": 5,
"email_sent": 1,
"share_created": 1,
"share_revoked": 0
},
"linkOpens": 8,
"total": 22,
"recent": [
{
"id": "ev_1",
"eventType": "viewed",
"actorKind": "recipient",
"shareId": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
"sourceIp": "203.0.113.4",
"userAgent": "Mozilla/5.0",
"metadata": null,
"createdAt": "2026-06-21T10:10:00.000Z"
}
]
}{
"error": {
"code": "unauthorized",
"message": "Missing Bearer token."
}
}{
"error": {
"code": "not_found",
"message": "Render not found."
}
}Renders
Get engagement summary
Aggregate engagement counts plus the most recent events for a render.
GET
/
v1
/
renders
/
{id}
/
engagement
Get engagement summary
curl --request GET \
--url https://api.craftkit.dev/v1/renders/{id}/engagement \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.craftkit.dev/v1/renders/{id}/engagement"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.craftkit.dev/v1/renders/{id}/engagement', 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.craftkit.dev/v1/renders/{id}/engagement",
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.craftkit.dev/v1/renders/{id}/engagement"
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.craftkit.dev/v1/renders/{id}/engagement")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.craftkit.dev/v1/renders/{id}/engagement")
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{
"counts": {
"viewed": 12,
"downloaded": 3,
"printed": 0,
"email_opened": 5,
"email_sent": 1,
"share_created": 1,
"share_revoked": 0
},
"linkOpens": 8,
"total": 22,
"recent": [
{
"id": "ev_1",
"eventType": "viewed",
"actorKind": "recipient",
"shareId": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
"sourceIp": "203.0.113.4",
"userAgent": "Mozilla/5.0",
"metadata": null,
"createdAt": "2026-06-21T10:10:00.000Z"
}
]
}{
"error": {
"code": "unauthorized",
"message": "Missing Bearer token."
}
}{
"error": {
"code": "not_found",
"message": "Render not found."
}
}Authorizations
Project API key (ck_live_… or ck_test_…) presented as a bearer token.
For embed partner endpoints this is the partner secret key, which is the
same credential type.
Path Parameters
The render id.
⌘I