API Reference

Sequence

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve sequence performance

client.sequence.retrievePerformance(stringid, RequestOptionsoptions?): SequenceRetrievePerformanceResponse { byStepType, perStep }

GET/v1/sequences/{id}/performance

Retrieves a sequence’s lifetime engagement, totalled by step type and broken down per step, with the live enrollments currently on each step. Test runs are not counted. A sequence that has never been published reports zero counts and no steps.

Required scope: sequences:read

Rate limit category: Read

ParametersExpand Collapse

id: string

Unique identifier of the sequence.

ReturnsExpand Collapse

SequenceRetrievePerformanceResponse { byStepType, perStep }

byStepType: ByStepType { EMAIL, LINKEDIN_INVITE, LINKEDIN_MESSAGE, 2 more }

Lifetime totals for each step type, across all of its steps.

EMAIL: Email { bounced, bounceRate, currentEnrollments, 6 more }

Email steps.

bounced: number

Sent emails that bounced.

minimum-9007199254740991

maximum9007199254740991

bounceRate: number | null

Bounced divided by sent; null if none sent.

currentEnrollments: number

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

delivered: number

Sent minus bounced, never below zero.

minimum-9007199254740991

maximum9007199254740991

opened: number

Sent emails that were opened.

minimum-9007199254740991

maximum9007199254740991

openRate: number | null

Opened divided by delivered; null if none delivered.

replied: number

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

replyRate: number | null

Replied divided by delivered; null if none delivered.

sent: number

Messages sent.

minimum-9007199254740991

maximum9007199254740991

LINKEDIN_INVITE: LinkedinInvite { acceptanceRate, accepted, currentEnrollments, 3 more }

LinkedIn connection request steps.

acceptanceRate: number | null

Accepted divided by sent; null if none sent.

accepted: number

Connection requests that were accepted.

minimum-9007199254740991

maximum9007199254740991

currentEnrollments: number

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

replied: number

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

replyRate: number | null

Replied divided by sent; null if none sent.

sent: number

Messages sent.

minimum-9007199254740991

maximum9007199254740991

LINKEDIN_MESSAGE: LinkedinMessage { currentEnrollments, read, readRate, 3 more }

LinkedIn message steps.

currentEnrollments: number

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

read: number

Sent messages that were read.

minimum-9007199254740991

maximum9007199254740991

readRate: number | null

Read divided by sent; null if none sent.

replied: number

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

replyRate: number | null

Replied divided by sent; null if none sent.

sent: number

Messages sent.

minimum-9007199254740991

maximum9007199254740991

WAIT: Wait { currentEnrollments }

Wait steps.

currentEnrollments: number

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

WAIT_FOR_CONNECTION: WaitForConnection { currentEnrollments }

Wait-for-connection steps.

currentEnrollments: number

Enrollments currently on steps of this type, paused ones included.

minimum-9007199254740991

maximum9007199254740991

perStep: Array<EmailStep { bounced, bounceRate, currentEnrollments, 8 more } | LinkedInMessageStep { currentEnrollments, read, readRate, 5 more } | LinkedInInviteStep { acceptanceRate, accepted, currentEnrollments, 5 more } | 2 more>

Per-step statistics in published sequence order, including steps with no activity. Steps no longer in the published definition are included if they have sent messages.

One of the following:

EmailStep { bounced, bounceRate, currentEnrollments, 8 more }

bounced: number

Sent emails that bounced.

minimum-9007199254740991

maximum9007199254740991

bounceRate: number | null

Bounced divided by sent; null if none sent.

currentEnrollments: number

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

delivered: number

Sent minus bounced, never below zero.

minimum-9007199254740991

maximum9007199254740991

opened: number

Sent emails that were opened.

minimum-9007199254740991

maximum9007199254740991

openRate: number | null

Opened divided by delivered; null if none delivered.

replied: number

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

replyRate: number | null

Replied divided by delivered; null if none delivered.

sent: number

Messages sent.

minimum-9007199254740991

maximum9007199254740991

sequenceStepId: string

ID of the step. A step no longer in the published definition keeps its original ID.

sequenceStepType: "EMAIL"

LinkedInMessageStep { currentEnrollments, read, readRate, 5 more }

currentEnrollments: number

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

read: number

Sent messages that were read.

minimum-9007199254740991

maximum9007199254740991

readRate: number | null

Read divided by sent; null if none sent.

replied: number

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

replyRate: number | null

Replied divided by sent; null if none sent.

sent: number

Messages sent.

minimum-9007199254740991

maximum9007199254740991

sequenceStepId: string

ID of the step. A step no longer in the published definition keeps its original ID.

sequenceStepType: "LINKEDIN_MESSAGE"

LinkedInInviteStep { acceptanceRate, accepted, currentEnrollments, 5 more }

acceptanceRate: number | null

Accepted divided by sent; null if none sent.

accepted: number

Connection requests that were accepted.

minimum-9007199254740991

maximum9007199254740991

currentEnrollments: number

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

replied: number

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

replyRate: number | null

Replied divided by sent; null if none sent.

sent: number

Messages sent.

minimum-9007199254740991

maximum9007199254740991

sequenceStepId: string

ID of the step. A step no longer in the published definition keeps its original ID.

sequenceStepType: "LINKEDIN_INVITE"

WaitStep { currentEnrollments, sequenceStepId, sequenceStepType }

currentEnrollments: number

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

sequenceStepId: string

ID of the step. A step no longer in the published definition keeps its original ID.

sequenceStepType: "WAIT"

WaitForConnectionStep { currentEnrollments, sequenceStepId, sequenceStepType }

currentEnrollments: number

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

sequenceStepId: string

ID of the step. A step no longer in the published definition keeps its original ID.

sequenceStepType: "WAIT_FOR_CONNECTION"

Retrieve sequence performance

TypeScript

HTTP

TypeScript

Python

Go

CLI Tool

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const sequenceRetrievePerformanceResponse = await client.sequence.retrievePerformance('id');

console.log(sequenceRetrievePerformanceResponse.byStepType);

200 example

{
  "byStepType": {
    "EMAIL": {
      "bounced": -9007199254740991,
      "bounceRate": 0,
      "currentEnrollments": -9007199254740991,
      "delivered": -9007199254740991,
      "opened": -9007199254740991,
      "openRate": 0,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991
    },
    "LINKEDIN_INVITE": {
      "acceptanceRate": 0,
      "accepted": -9007199254740991,
      "currentEnrollments": -9007199254740991,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991
    },
    "LINKEDIN_MESSAGE": {
      "currentEnrollments": -9007199254740991,
      "read": -9007199254740991,
      "readRate": 0,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991
    },
    "WAIT": {
      "currentEnrollments": -9007199254740991
    },
    "WAIT_FOR_CONNECTION": {
      "currentEnrollments": -9007199254740991
    }
  },
  "perStep": [
    {
      "bounced": -9007199254740991,
      "bounceRate": 0,
      "currentEnrollments": -9007199254740991,
      "delivered": -9007199254740991,
      "opened": -9007199254740991,
      "openRate": 0,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991,
      "sequenceStepId": "sequenceStepId",
      "sequenceStepType": "EMAIL"
    }
  ]
}

Returns Examples

200 example

{
  "byStepType": {
    "EMAIL": {
      "bounced": -9007199254740991,
      "bounceRate": 0,
      "currentEnrollments": -9007199254740991,
      "delivered": -9007199254740991,
      "opened": -9007199254740991,
      "openRate": 0,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991
    },
    "LINKEDIN_INVITE": {
      "acceptanceRate": 0,
      "accepted": -9007199254740991,
      "currentEnrollments": -9007199254740991,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991
    },
    "LINKEDIN_MESSAGE": {
      "currentEnrollments": -9007199254740991,
      "read": -9007199254740991,
      "readRate": 0,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991
    },
    "WAIT": {
      "currentEnrollments": -9007199254740991
    },
    "WAIT_FOR_CONNECTION": {
      "currentEnrollments": -9007199254740991
    }
  },
  "perStep": [
    {
      "bounced": -9007199254740991,
      "bounceRate": 0,
      "currentEnrollments": -9007199254740991,
      "delivered": -9007199254740991,
      "opened": -9007199254740991,
      "openRate": 0,
      "replied": -9007199254740991,
      "replyRate": 0,
      "sent": -9007199254740991,
      "sequenceStepId": "sequenceStepId",
      "sequenceStepType": "EMAIL"
    }
  ]
}