Skip to main content
GET
/
v1
/
renders
/
{id}
/
engagement
Get engagement summary
curl --request GET \
  --url https://api.craftkit.dev/v1/renders/{id}/engagement \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

​
id
string<uuid>
required

The render id.

Response

Engagement summary.

​
counts
object
required

Per-event-type counts (all keys present, zero-filled).

​
linkOpens
integer
required

Count of viewed events originating from a shared link.

​
total
integer
required
​
recent
object[]
required