Sequences

Get details of sequences.

Select

The cmdlet will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the cmdlet.

Id supports the '=,IN,>=,<=,>,<' operators.
ClickCount supports the '=,>=,<=,>,<' operators.
CreatedAt supports the '=,>=,<=,>,<' operators.
DeliverCount supports the '=,>=,<=,>,<' operators.
Name supports the '=,IN' operators.
EnabledAt supports the '=,>=,<=,>,<' operators.
LastUsedAt supports the '=,>=,<=,>,<' operators.
LockedAt supports the '=,>=,<=,>,<' operators.
OpenCount supports the '=,>=,<=,>,<' operators.
ReplyCount supports the '=,>=,<=,>,<' operators.
ThrottleCapacity supports the '=,>=,<=,>,<' operators.
ThrottleMaxAddsPerDay supports the '=,>=,<=,>,<' operators.
UpdatedAt supports the '=,>=,<=,>,<' operators.

For example, the following query is processed server side:

SELECT * FROM Sequences WHERE Id = 1

SELECT * FROM Sequences WHERE Id IN (1, 2)

SELECT * FROM Sequences WHERE Id >= 1

SELECT * FROM Sequences WHERE Id <= 1

SELECT * FROM Sequences WHERE Id > 1

SELECT * FROM Sequences WHERE Id < 2

SELECT * FROM Sequences WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE DeliverCount = 0

SELECT * FROM Sequences WHERE Name = 'test'

SELECT * FROM Sequences WHERE ThrottleMaxAddsPerDay = 1

Columns


Name	Type	Description
Id [KEY]	Integer	Id of sequence template.
AutomationPercentage	Double	The percentage of auto_email sequence steps in this sequence.
BounceCount	Integer	The total count of bounced mailings during this sequence.
ClickCount	Integer	The total count of clicked mailings from this sequence.
CreatedAt	Datetime	The date and time the sequence was created.
DeliverCount	Integer	The total count of delivered mailings from this sequence.
Description	String	A custom description for the sequence.
DurationInDays	Integer	The total number of days it takes to get through this sequence.
Enabled	Boolean	A boolean value determining whether the sequence is enabled or not.
EnabledAt	Datetime	The date and time the sequence was enabled or null if currently disabled.
FailureCount	Integer	The total count of failed mailings from this sequence.
LastUsedAt	Datetime	The date and time the sequence was last used.
Locked	Boolean	A boolean value determining whether the sequence is locked or not.
LockedAt	Datetime	The date and time the sequence was locked or null if currently unlocked.
MaxActivations	Integer	The maximum number of prospects that can be associated with the sequence.
Name	String	The name or the sequence.
NegativeReplyCount	Integer	The total count of negative reply mailings from this sequence.
NeutralReplyCount	Integer	The total count of neutral reply mailings from this sequence.
NumContactedProspects	Integer	The total count of prospects who have been either called or emailed.
NumRepliedProspects	Integer	The total count of prospects who have been marked as replied.
OpenCount	Integer	The total count of opened mailings from this sequence.
OptOutCount	Integer	The total count of opted out mailings from this sequence.
PositiveReplyCount	Integer	The total count of positive reply mailings from this sequence.
PrimaryReplyAction	String	The action to take when the primary prospect replies. The allowed values are finish, continue, pause.
PrimaryReplyPauseDuration	Integer	The duration in seconds to pause for before automatically finishing after a reply from the primary prospect if the primaryReplyAction is pause.
ReplyCount	Integer	The total count of replied mailings from this sequence.
ScheduleCount	Integer	The total count of scheduled mailings from this sequence.
ScheduleIntervalType	String	The schedule interval type.
SecondaryReplyAction	String	The action to take when someone other than the primary prospect replies. The allowed values are finish, continue, pause.
SecondaryReplyPauseDuration	Integer	The duration in seconds to pause for before automatically finishing after a reply from anyone other than the primary prospect if the secondaryReplyAction is pause.
SequenceStepCount	Integer	The total number of sequence steps in this sequence.
SequenceType	String	The sequence type must be either date or interval. The allowed values are date, interval.
ShareType	String	The sequence share type. The allowed values are private, read_only, shared.
Tags	String	A list of tag values associated with the sequence.
ThrottleCapacity	Integer	The maximum number of associated sequence states per user that can be active at a one time.
ThrottleMaxAddsPerDay	Integer	The maximum number of associated sequence states per user that can be added to the sequence each day.
ThrottlePaused	Boolean	A boolean value determining whether the throttling of sequence states is paused or not.
ThrottlePausedAt	Datetime	The date and time the sequence state throttling was paused or null if not currently paused.
Transactional	Boolean	A boolean value determining whether prospect opt out preferences are respected.
UpdatedAt	Datetime	The date and time the sequence was last updated.
LinksSelf	String	Link self.
CreatorId	Integer	Creator Id.
OwnerId	Integer	Owner Id.
SequenceStatesLinks	String	Sequence states links.
UpdaterId	Integer	Updater Id.
RulesetId	Integer	Ruleset Id.
Type	String	Type.

Cmdlets for Outreach

Sequences

Select

Columns