API Reference

Sequence

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve sequence performance

client.Sequence.GetPerformance(ctx, id) (*SequenceRetrievePerformanceResponse, error)

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

type SequenceRetrievePerformanceResponse struct{…}

ByStepType SequenceRetrievePerformanceResponseByStepType

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

Email SequenceRetrievePerformanceResponseByStepTypeEmail

Email steps.

Bounced int64

Sent emails that bounced.

minimum-9007199254740991

maximum9007199254740991

BounceRate float64

Bounced divided by sent; null if none sent.

CurrentEnrollments int64

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

minimum-9007199254740991

maximum9007199254740991

Delivered int64

Sent minus bounced, never below zero.

minimum-9007199254740991

maximum9007199254740991

Opened int64

Sent emails that were opened.

minimum-9007199254740991

maximum9007199254740991

OpenRate float64

Opened divided by delivered; null if none delivered.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by delivered; null if none delivered.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

LinkedinInvite SequenceRetrievePerformanceResponseByStepTypeLinkedinInvite

LinkedIn connection request steps.

AcceptanceRate float64

Accepted divided by sent; null if none sent.

Accepted int64

Connection requests that were accepted.

minimum-9007199254740991

maximum9007199254740991

CurrentEnrollments int64

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

minimum-9007199254740991

maximum9007199254740991

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

LinkedinMessage SequenceRetrievePerformanceResponseByStepTypeLinkedinMessage

LinkedIn message steps.

CurrentEnrollments int64

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

minimum-9007199254740991

maximum9007199254740991

Read int64

Sent messages that were read.

minimum-9007199254740991

maximum9007199254740991

ReadRate float64

Read divided by sent; null if none sent.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

Wait SequenceRetrievePerformanceResponseByStepTypeWait

Wait steps.

CurrentEnrollments int64

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

minimum-9007199254740991

maximum9007199254740991

WaitForConnection SequenceRetrievePerformanceResponseByStepTypeWaitForConnection

Wait-for-connection steps.

CurrentEnrollments int64

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

minimum-9007199254740991

maximum9007199254740991

PerStep []SequenceRetrievePerformanceResponsePerStepUnion

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:

type SequenceRetrievePerformanceResponsePerStepEmailStep struct{…}

Bounced int64

Sent emails that bounced.

minimum-9007199254740991

maximum9007199254740991

BounceRate float64

Bounced divided by sent; null if none sent.

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Delivered int64

Sent minus bounced, never below zero.

minimum-9007199254740991

maximum9007199254740991

Opened int64

Sent emails that were opened.

minimum-9007199254740991

maximum9007199254740991

OpenRate float64

Opened divided by delivered; null if none delivered.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by delivered; null if none delivered.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

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

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepLinkedInMessageStep struct{…}

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Read int64

Sent messages that were read.

minimum-9007199254740991

maximum9007199254740991

ReadRate float64

Read divided by sent; null if none sent.

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

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

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepLinkedInInviteStep struct{…}

AcceptanceRate float64

Accepted divided by sent; null if none sent.

Accepted int64

Connection requests that were accepted.

minimum-9007199254740991

maximum9007199254740991

CurrentEnrollments int64

Enrollments currently on this step, paused ones included.

minimum-9007199254740991

maximum9007199254740991

Replied int64

Sent messages that received a reply.

minimum-9007199254740991

maximum9007199254740991

ReplyRate float64

Replied divided by sent; null if none sent.

Sent int64

Messages sent.

minimum-9007199254740991

maximum9007199254740991

SequenceStepID string

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

SequenceStepType string

type SequenceRetrievePerformanceResponsePerStepWaitStep struct{…}

CurrentEnrollments int64

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 string

type SequenceRetrievePerformanceResponsePerStepWaitForConnectionStep struct{…}

CurrentEnrollments int64

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 string

Retrieve sequence performance

Go

HTTP

TypeScript

Python

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  sequenceRetrievePerformanceResponse, err := client.Sequence.GetPerformance(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
    }
  ]
}