GraphQL RepositoriesaccountKpi

`entities.accountKpi`

Read account KPI records with the accountKpi repository, and change them with the account KPI mutations. Same records as the REST AccountKPIs entity.

Example: first three account KPI recordsGraphQLcURL

query FirstAccountKPIs {
  entities {
    accountKpi {
      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 FirstAccountKPIs { entities { accountKpi { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { accountKpi { … } }.

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.	AccountKPIEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AccountKPIEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AccountKPIFilterInput, orderBy: [AccountKPIOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AccountKPIEntity!]!
QUERY	`getByCriteria`(filter: AccountKPIFilterInput, orderBy: [AccountKPIOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AccountKPIEntityConnection
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	`createAccountKpi`(input: CreateAccountKPIInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAccountKPIPayload
MUTATION	`updateAccountKpi`(input: UpdateAccountKPIInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAccountKPIPayload
MUTATION	`bulkUpdateAccountKpi`(input: [CreateOrUpdateAccountKPIInput!]!, deleteInput: [DeleteAccountKPIInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAccountKPIPayload
MUTATION	`deleteAccountKpi`(input: DeleteAccountKPIInput!)	Soft-delete	DeleteAccountKPIPayload

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.

AccountKPIEntity object 17 fields: isDeleteProtected, id, isDeleted, …

Recorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports.

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.
`account`	AccountEntity	Account this KPI event relates to.
`client`	ClientEntity	User who triggered the KPI event (e.g. created or archived the account, sent the first email).
`owner`	ClientEntity	Account owner at the time the KPI event occurred.
`unit`	SalesUnitEntity	Sales unit the triggering user belonged to at the time of the event.
`accountId`	ID!	Id of the account this KPI event relates to.
`applicationId`	ID	Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
`clientId`	ID	Id of the user who triggered the event.
`kpi`	AccountKpiEnum!	KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified.
`ownerId`	ID!	Id of the account owner at the time of the event.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

AccountKPIEntityConnection object pageInfo: PageInfo!, edges: [AccountKPIEntityEdge]!, totalCount: Int

Paginated list of AccountKPI records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[AccountKPIEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

AccountKPIEntityEdge object node: AccountKPIEntity, cursor: String!

A Relay edge containing a AccountKPIEntity and its cursor.

Field	Type	Description
`node`	AccountKPIEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

AccountKpiEnumFilterInput input eq: [AccountKpiEnum!], NOT: AccountKpiEnumFilterInput

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

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

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

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

Input field	Type	Description
`OR`	[AccountKPIFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AccountKPIFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AccountKPIFilterInput	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.
`accountId`	EntityFilterStringField	Id of the account this KPI event relates to.
`applicationId`	EntityFilterStringField	Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
`clientId`	EntityFilterStringField	Id of the user who triggered the event.
`kpi`	AccountKpiEnumFilterInput	KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified.
`ownerId`	EntityFilterStringField	Id of the account owner at the time of the event.
`unitId`	EntityFilterStringField	Id of the sales unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`account`	AccountFilterInput	Account this KPI event relates to. Matches records where a related record meets these conditions.
`client`	ClientFilterInput	User who triggered the KPI event (e.g. created or archived the account, sent the first email). Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	Account owner at the time the KPI event occurred. Matches records where a related record meets these conditions.
`unit`	SalesUnitFilterInput	Sales unit the triggering user belonged to at the time of the event. Matches records where a related record meets these conditions.

AccountKPIOrderByInput input Asc or Desc per field

Sorting of AccountKPI 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.
`account`	[AccountOrderByNestedInput!]	Account this KPI event relates to. Sorts by fields of the related record, listed in order of priority.
`client`	[ClientOrderByNestedInput!]	User who triggered the KPI event (e.g. created or archived the account, sent the first email). Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	Account owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority.
`unit`	[SalesUnitOrderByNestedInput!]	Sales unit the triggering user belonged to at the time of the event. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the account this KPI event relates to.
`clientId`	OrderByEnum	Id of the user who triggered the event.
`ownerId`	OrderByEnum	Id of the account owner at the time of the event.
`unitId`	OrderByEnum	Id of the sales unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateAccountKPIInput input 10 fields: clientMutationId, modified, created, …

Field values of a new AccountKPI 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.
`accountId`	ID!	Id of the account this KPI event relates to.
`applicationId`	ID	Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
`clientId`	ID	Id of the user who triggered the event.
`kpi`	AccountKpiEnum!	KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified.
`ownerId`	ID!	Id of the account owner at the time of the event.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateAccountKPIInput input 11 fields: clientMutationId, id, modified, …

Field values of an AccountKPI 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.
`accountId`	ID	Id of the account this KPI event relates to.
`applicationId`	ID	Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
`clientId`	ID	Id of the user who triggered the event.
`kpi`	AccountKpiEnum	KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified.
`ownerId`	ID	Id of the account owner at the time of the event.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

DeleteAccountKPIInput input clientMutationId: String, id: ID!

Id of the AccountKPI 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.

UpdateAccountKPIInput input 11 fields: clientMutationId, id, modified, …

Id of an AccountKPI 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.
`accountId`	ID	Id of the account this KPI event relates to.
`applicationId`	ID	Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration).
`clientId`	ID	Id of the user who triggered the event.
`kpi`	AccountKpiEnum	KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive or LastModified.
`ownerId`	ID	Id of the account owner at the time of the event.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAccountKPIPayload object result: BulkUpdateResults!

Result of the bulkUpdateAccountKpi mutation.

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

CreateAccountKPIPayload object accountKpi: AccountKPIEntity, clientMutationId: String

Result of the createAccountKpi mutation.

Field	Type	Description
`accountKpi`	AccountKPIEntity	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).

DeleteAccountKPIPayload object accountKpi: AccountKPIEntity, clientMutationId: String

Result of the deleteAccountKpi mutation.

Field	Type	Description
`accountKpi`	AccountKPIEntity	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).

UpdateAccountKPIPayload object accountKpi: AccountKPIEntity, clientMutationId: String

Result of the updateAccountKpi mutation.

Field	Type	Description
`accountKpi`	AccountKPIEntity	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).

AccountKpiEnum enum CreateAccount, LastEmailSent, FirstEmailSent, Archive, LastModified

Kind of account event recorded as a KPI entry; each account keeps at most one entry per kind.

Value	Description
`CreateAccount`	The account was created.
`LastEmailSent`	The most recent email was sent to the account.
`FirstEmailSent`	The first email was sent to the account.
`Archive`	The account was archived; the entry is removed when it is unarchived.
`LastModified`	The account was last modified.