OBJECT

EmailSequenceStats

Statistics of an email sequence for a period: enrollments, sent emails with their opens, clicks and replies, and the records it created.

link GraphQL Schema definition

  • type EmailSequenceStats implements EmailSequenceCountStats {
  • # Number of sent emails that were opened at least once.
  • openCount: Int!
  • # Number of sent emails in which at least one link was clicked.
  • clickCount: Int!
  • # Number of sent emails that received a reply.
  • replyCount: Int!
  • # Number of sent emails through which the recipient unsubscribed.
  • unsubscribeCount: Int!
  • # Number of emails sent.
  • sentCount: Int!
  • # Number of tasks created by the sequence steps.
  • createTaskCount: Int!
  • # Number of leads created by the sequence steps.
  • createLeadCount: Int!
  • # Number of text messages sent by the sequence steps.
  • createTextCount: Int!
  • # Number of enrolled records for which the sequence created at least one task.
  • createTaskRecipientsCount: Int!
  • # Number of enrolled records for which the sequence created at least one lead.
  • createLeadRecipientsCount: Int!
  • # Number of enrolled records the sequence sent at least one text message to.
  • createTextRecipientsCount: Int!
  • # Number of enrollments that are still running.
  • currentEnrollCount: Int!
  • # Number of enrollments that ended because the record was unenrolled.
  • unenrollCount: Int!
  • # Number of enrolled records the sequence sent at least one email to.
  • sentRecipientsCount: Int!
  • # Number of enrolled records that were sent emails but opened none of them.
  • notOpenRecipientsCount: Int!
  • # Number of enrolled records that opened at least one email.
  • openRecipientsCount: Int!
  • # Number of enrolled records that clicked a link in an email.
  • clickRecipientsCount: Int!
  • # Number of enrolled records that replied to at least one email.
  • replyRecipientsCount: Int!
  • # Number of enrolled records with at least one bounced email.
  • bounceRecipientsCount: Int!
  • # Number of sent emails that were not opened.
  • notOpenCount: Int!
  • # Number of enrollments.
  • enrollCount: Int!
  • # Number of sent emails that bounced.
  • bounceCount: Int!
  • # Statistics of each step, in step order. They count only activity since the step
  • # statistics were last reset.
  • steps: [EmailSequenceStepStats!]!
  • # Records behind one of the counts, chosen by `type`, as a list view. Empty for a
  • # sequence without settings.
  • #
  • # Arguments
  • # type: Count whose records are listed, such as Open or NotOpen.
  • # filter: Extra filter on the listed records, as a JSON object
  • # whose __typename names the filter for the record type, for example
  • # {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies
  • # no extra filter.
  • # searchQuery: Fulltext search by string. When null, search is
  • # not applied.
  • # sortBy: Id of the field the items are sorted by.
  • # sortOrder: Options settings for tab grid sort order listing
  • # displayColumn: Columns returned for each item, given by field
  • # id and display option; the values of each item follow the order of this list.
  • # highlightChanges: Highlighting of recent changes: values
  • # changed within the period carry their latest change in the change field of the
  • # row data.
  • # limit: Maximum number of items returned in one call.
  • # offset: Number of items to skip before the first returned item;
  • # starts at 0.
  • # maxRecords: Max total records to return. If null, then no
  • # limit.
  • recipients(
  • type: EmailSequenceStatsRecipientTypeEnum!,
  • filter: DrilldownFilterJSONString,
  • searchQuery: String,
  • sortBy: ID!,
  • sortOrder: SortOrder!,
  • displayColumn: [DisplayColumnParams!]!,
  • highlightChanges: GridHighlightChangesParams,
  • limit: Int,
  • offset: Int,
  • maxRecords: Int
  • ): GenericDrilldownDataGridViewItems
  • # Tasks created by the sequence, as a list view.
  • #
  • # Arguments
  • # filter: Extra filter on the listed records, as a JSON object
  • # whose __typename names the filter for the record type, for example
  • # {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies
  • # no extra filter.
  • # searchQuery: Fulltext search by string. When null, search is
  • # not applied.
  • # sortBy: Id of the field the items are sorted by.
  • # sortOrder: Options settings for tab grid sort order listing
  • # displayColumn: Columns returned for each item, given by field
  • # id and display option; the values of each item follow the order of this list.
  • # highlightChanges: Highlighting of recent changes: values
  • # changed within the period carry their latest change in the change field of the
  • # row data.
  • # limit: Maximum number of items returned in one call.
  • # offset: Number of items to skip before the first returned item;
  • # starts at 0.
  • # maxRecords: Max total records to return. If null, then no
  • # limit.
  • createdTasks(
  • filter: DrilldownFilterJSONString,
  • searchQuery: String,
  • sortBy: ID!,
  • sortOrder: SortOrder!,
  • displayColumn: [DisplayColumnParams!]!,
  • highlightChanges: GridHighlightChangesParams,
  • limit: Int,
  • offset: Int,
  • maxRecords: Int
  • ): GenericDrilldownDataGridViewItems!
  • # Leads created by the sequence, as a list view.
  • #
  • # Arguments
  • # filter: Extra filter on the listed records, as a JSON object
  • # whose __typename names the filter for the record type, for example
  • # {"__typename": "AccountDrilldownFilter", "ownerId": [""]}. Null applies
  • # no extra filter.
  • # searchQuery: Fulltext search by string. When null, search is
  • # not applied.
  • # sortBy: Id of the field the items are sorted by.
  • # sortOrder: Options settings for tab grid sort order listing
  • # displayColumn: Columns returned for each item, given by field
  • # id and display option; the values of each item follow the order of this list.
  • # highlightChanges: Highlighting of recent changes: values
  • # changed within the period carry their latest change in the change field of the
  • # row data.
  • # limit: Maximum number of items returned in one call.
  • # offset: Number of items to skip before the first returned item;
  • # starts at 0.
  • # maxRecords: Max total records to return. If null, then no
  • # limit.
  • createdLeads(
  • filter: DrilldownFilterJSONString,
  • searchQuery: String,
  • sortBy: ID!,
  • sortOrder: SortOrder!,
  • displayColumn: [DisplayColumnParams!]!,
  • highlightChanges: GridHighlightChangesParams,
  • limit: Int,
  • offset: Int,
  • maxRecords: Int
  • ): GenericDrilldownDataGridViewItems!
  • # Statistics over time, one item per period with activity, oldest first.
  • #
  • # Arguments
  • # period: Length of the periods the statistics are grouped by.
  • timeline(period: EmailSequenceTimelinePeriodEnum!): [EmailSequencePeriodStats!]!
  • }