OBJECT

EmailSequenceEntity

link GraphQL Schema definition

  • type EmailSequenceEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • owner: ClientEntity
  • # Field whose values are strictly defined with an enumeration of values.
  • deactivationReason: EmailSequenceDeactivationReasonEnum
  • # Multi-line text input field.
  • description: String
  • # Boolean value.
  • isEnabled: Boolean
  • # Datetime information.
  • lastSchemaChange: DateTime
  • # Datetime information.
  • lastStatusChange: DateTime
  • # Name of the entity and its default text representation.
  • name: String!
  • # Relation to single entity instance.
  • ownerId: ID!
  • settings: EmailSequenceSchema
  • # Field whose values are strictly defined with an enumeration of values.
  • type: ProcessTypeEnum!
  • # Relations to EmailSequenceActivityLogs.
  • #
  • # Arguments
  • # filter: Filter EmailSequenceActivityLog relations by target
  • # EmailSequenceActivityLog attributes.
  • # orderBy: Order EmailSequenceActivityLog relations by target
  • # EmailSequenceActivityLog attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • activityLogs(
  • filter: EmailSequenceActivityLogFilterInput,
  • orderBy: [EmailSequenceActivityLogOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EmailSequenceActivityLogEntityConnection
  • # Relations to CloudObjects.
  • documents: [CloudObjectRelationEntity!]
  • # Relations to EmailSequenceEnrolleds.
  • #
  • # Arguments
  • # filter: Filter EmailSequenceEnrolled relations by target
  • # EmailSequenceEnrolled attributes.
  • # orderBy: Order EmailSequenceEnrolled relations by target
  • # EmailSequenceEnrolled attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • enrolled(
  • filter: EmailSequenceEnrolledFilterInput,
  • orderBy: [EmailSequenceEnrolledOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EmailSequenceEnrolledEntityConnection
  • status: ProcessStatusEnum
  • lastEmailSequenceRun: DateTime
  • clickRate: Float
  • bounceRate: Float
  • openRate: Float
  • replyRate: Float
  • unsubscribeRate: Float
  • createdCount: Int!
  • sentCount: Int!
  • enrollCount: Int!
  • triggerEntityName: EntityNameEnum
  • triggerFieldId: UUID
  • stepCount: Int
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Arguments
  • # period: [Not documented]
  • stats(period: EmailSequenceStatsPeriodEnum!): EmailSequenceStats!
  • }