How one sequence is doing
The same numbers as `/org/sequences/stats`, for one sequence whatever its status: people enrolled, active, finished and exited by reason; messages sent by channel; reply rate per person contacted; open and click rates per email sent (opens are inflated by Apple Mail Privacy Protection). Every rate comes with its counts, and `definitions` spells out each number.
The same numbers as /org/sequences/stats, for one sequence whatever its status: people enrolled, active, finished and exited by reason; messages sent by channel; reply rate per person contacted; open and click rates per email sent (opens are inflated by Apple Mail Privacy Protection). Every rate comes with its counts, and definitions spells out each number.
API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...
In: header
Path Parameters
uuidQuery Parameters
First UTC day counted (YYYY-MM-DD). Omit for no lower bound.
dateLast UTC day counted, inclusive (YYYY-MM-DD). Omit for no upper bound.
dateResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/api/v1/org/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/stats"{
"data": {
"range": {
"from": "string",
"to": "string"
},
"sequence": {
"people": {
"enrolled": 9007199254740991,
"active": 9007199254740991,
"finished": 9007199254740991,
"exited": {
"total": 9007199254740991,
"replied": 9007199254740991,
"unsubscribed": 9007199254740991,
"bounced": 9007199254740991,
"failed": 9007199254740991,
"other": 9007199254740991
}
},
"messages": {
"sent": 9007199254740991,
"email": {
"sent": 9007199254740991,
"bounced": 9007199254740991
},
"linkedin": {
"sent": 9007199254740991,
"invites": 9007199254740991,
"messages": 9007199254740991
}
},
"replies": {
"people_replied": 9007199254740991,
"people_contacted": 9007199254740991,
"reply_rate": 1
},
"opens": {
"emails_opened": 9007199254740991,
"emails_sent": 9007199254740991,
"open_rate": 1
},
"clicks": {
"emails_clicked": 9007199254740991,
"emails_sent": 9007199254740991,
"click_rate": 1
},
"sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
"name": "string",
"status": "draft",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9"
},
"definitions": {
"range": "string",
"people": "string",
"messages": "string",
"reply_rate": "string",
"open_rate": "string",
"click_rate": "string",
"rates": "string",
"totals": "string"
}
}
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "module_required",
"module": "string",
"message": "string",
"contact": "string"
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}Write a planned message again POST
Ask the writer for another version of one message, optionally saying what should change. Unlike the PATCH beside it, this spends a model call — and it is the only way to get a new version that still knows the district's research, the org's note on the contact, and what the earlier steps in the chain already said. Replaces the message in place, so a message parked for review stays parked. On failure the existing message is left untouched.
How every sequence is doing GET
Outreach numbers for each sequence the index lists (archived ones left out), newest first, plus `totals` summed across them: people enrolled, still active, finished, and exited by reason (replied, unsubscribed, bounced, failed, other); messages sent, split into email and LinkedIn; and reply, open and click rates, each returned with its numerator and denominator. Reply rate is per person contacted; open and click rates are per email sent. Opens are inflated by Apple Mail Privacy Protection, so open rate is an upper bound. `from` / `to` select people by enrollment date and messages by send date; replies, opens and clicks are credited to those messages whenever they arrived. The response carries `definitions` spelling out every number. Gated by the `sequencer` module; otherwise responds 403 module_required.