GraphQL RepositoriesemailEvent

`entities.emailEvent`

Read email event records with the emailEvent repository, and change them with the email event mutations. Same records as the REST EmailEvents entity.

Example: first three email event recordsGraphQLcURL

query FirstEmailEvents {
  entities {
    emailEvent {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstEmailEvents { entities { emailEvent { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { emailEvent { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	EmailEventEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EmailEventEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EmailEventFilterInput, orderBy: [EmailEventOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EmailEventEntity!]!
QUERY	`getByCriteria`(filter: EmailEventFilterInput, orderBy: [EmailEventOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter as a cursor-paginated connection.	[EmailEventEntity!]!
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createEmailEvent`(input: CreateEmailEventInput!, validationLevel: [ValidationLevel!])	Create one record	CreateEmailEventPayload
MUTATION	`updateEmailEvent`(input: UpdateEmailEventInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateEmailEventPayload
MUTATION	`bulkUpdateEmailEvent`(input: [CreateOrUpdateEmailEventInput!]!, deleteInput: [DeleteEmailEventInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateEmailEventPayload
MUTATION	`deleteEmailEvent`(input: DeleteEmailEventInput!)	Soft-delete	DeleteEmailEventPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

EmailEventEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Tracking event reported for a sent email, such as an open, a link click, a reply or an unsubscribe.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`email`	EmailEntity	Email message the event was reported for.
`additionalData`	JSONString	Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.
`emailId`	ID!	Id of the email message.
`type`	EmailEventTypeEnum	Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.
`url`	String	URL the recipient interacted with. Set for click events; empty for other event types.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

EmailEventFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for EmailEvent records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[EmailEventFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EmailEventFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EmailEventFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`emailId`	EntityFilterStringField	Id of the email message.
`type`	EmailEventTypeEnumFilterInput	Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.
`url`	EntityFilterStringField	URL the recipient interacted with. Set for click events; empty for other event types.
`email`	EmailFilterInput	Email message the event was reported for. Matches records where a related record meets these conditions.

EmailEventOrderByInput input Asc or Desc per field

Sorting of EmailEvent records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`email`	[EmailOrderByNestedInput!]	Email message the event was reported for. Sorts by fields of the related record, listed in order of priority.
`emailId`	OrderByEnum	Id of the email message.
`type`	OrderByEnum	Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.
`url`	OrderByEnum	URL the recipient interacted with. Set for click events; empty for other event types.

EmailEventTypeEnumFilterInput input eq: [EmailEventTypeEnum!], NOT: EmailEventTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[EmailEventTypeEnum!]	Matches any of the listed values.
`NOT`	EmailEventTypeEnumFilterInput	Matches values that do not meet this condition.

CreateEmailEventInput input 7 fields: clientMutationId, modified, created, …

Field values of a new EmailEvent record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`additionalData`	JSONString	Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.
`emailId`	ID!	Id of the email message.
`type`	EmailEventTypeEnum	Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.
`url`	String	URL the recipient interacted with. Set for click events; empty for other event types.

CreateOrUpdateEmailEventInput input 8 fields: clientMutationId, id, modified, …

Field values of an EmailEvent record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`additionalData`	JSONString	Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.
`emailId`	ID	Id of the email message.
`type`	EmailEventTypeEnum	Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.
`url`	String	URL the recipient interacted with. Set for click events; empty for other event types.

DeleteEmailEventInput input clientMutationId: String, id: ID!

Id of the EmailEvent record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateEmailEventInput input 8 fields: clientMutationId, id, modified, …

Id of an EmailEvent record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`additionalData`	JSONString	Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.
`emailId`	ID	Id of the email message.
`type`	EmailEventTypeEnum	Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.
`url`	String	URL the recipient interacted with. Set for click events; empty for other event types.

BulkUpdateEmailEventPayload object result: BulkUpdateResults!

Result of the bulkUpdateEmailEvent mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateEmailEventPayload object emailEvent: EmailEventEntity, clientMutationId: String

Result of the createEmailEvent mutation.

Field	Type	Description
`emailEvent`	EmailEventEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteEmailEventPayload object emailEvent: EmailEventEntity, clientMutationId: String

Result of the deleteEmailEvent mutation.

Field	Type	Description
`emailEvent`	EmailEventEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateEmailEventPayload object emailEvent: EmailEventEntity, clientMutationId: String

Result of the updateEmailEvent mutation.

Field	Type	Description
`emailEvent`	EmailEventEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

EmailEventTypeEnum enum Open, Click, Unsubscribe, Bounce, Reply, BounceSoft

Type of a tracked event on a sent email.

Value	Description
`Open`	The recipient opened the email.
`Click`	The recipient clicked a link in the email.
`Unsubscribe`	The recipient unsubscribed through the email.
`Bounce`	The email bounced permanently (hard bounce).
`Reply`	The recipient replied to the email.
`BounceSoft`	Delivery failed temporarily or was delayed (soft bounce).