---
title: entities.contactKpi
description: Read contact KPI records with the contactKpi repository, and change them with the contact KPI mutations. Same records as the REST ContactKPIs entity.
canonical: https://developers.coevera.com/reference/graphql/contact-kpi/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.contactKpi

Read contact KPI records with the contactKpi repository, and change them with the contact KPI mutations. Same records as the REST ContactKPIs entity.

REST: [ContactKPIs](https://developers.coevera.com/reference/rest/contact-kpis.md).

## Queries

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

## Mutations

- `createContactKpi(input: CreateContactKPIInput!, validationLevel: [ValidationLevel!]): CreateContactKPIPayload` Create one record.
- `updateContactKpi(input: UpdateContactKPIInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateContactKPIPayload` Update fields.
- `bulkUpdateContactKpi(input: [CreateOrUpdateContactKPIInput!]!, deleteInput: [DeleteContactKPIInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateContactKPIPayload` Create or update many; per-item results.
- `deleteContactKpi(input: DeleteContactKPIInput!): DeleteContactKPIPayload` Soft-delete.

## Types

### ContactKPIEntity (object)

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

- `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.
- `client: ClientEntity` User who triggered the KPI event (e.g. created or archived the contact, sent the first email).
- `contact: ContactEntity` Contact this KPI event relates to.
- `owner: ClientEntity` Contact owner at the time the KPI event occurred.
- `unit: SalesUnitEntity` Sales unit the triggering user belonged to at the time of the event.
- `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.
- `contactId: ID!` Id of the contact this KPI event relates to.
- `kpi: ContactKpiEnum!` KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified.
- `ownerId: ID!` Id of the contact 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.

### ContactKPIEntityConnection (object)

Paginated list of ContactKPI records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [ContactKPIEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### ContactKPIEntityEdge (object)

A Relay edge containing a `ContactKPIEntity` and its cursor.

- `node: ContactKPIEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### ContactKpiEnumFilterInput (input)

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

- `eq: [ContactKpiEnum!]` Matches any of the listed values.
- `NOT: ContactKpiEnumFilterInput` Matches values that do not meet this condition.

### ContactKPIFilterInput (input)

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

- `OR: [ContactKPIFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ContactKPIFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ContactKPIFilterInput` 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.
- `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.
- `contactId: EntityFilterStringField` Id of the contact this KPI event relates to.
- `kpi: ContactKpiEnumFilterInput` KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified.
- `ownerId: EntityFilterStringField` Id of the contact owner at the time of the event.
- `unitId: EntityFilterStringField` Id of the sales unit.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `client: ClientFilterInput` User who triggered the KPI event (e.g. created or archived the contact, sent the first email). Matches records where a related record meets these conditions.
- `contact: ContactFilterInput` Contact this KPI event relates to. Matches records where a related record meets these conditions.
- `owner: ClientFilterInput` Contact 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.

### ContactKPIOrderByInput (input)

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

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `client: [ClientOrderByNestedInput!]` User who triggered the KPI event (e.g. created or archived the contact, sent the first email). Sorts by fields of the related record, listed in order of priority.
- `contact: [ContactOrderByNestedInput!]` Contact this KPI event relates to. Sorts by fields of the related record, listed in order of priority.
- `owner: [ClientOrderByNestedInput!]` Contact 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.
- `clientId: OrderByEnum` Id of the user who triggered the event.
- `contactId: OrderByEnum` Id of the contact this KPI event relates to.
- `ownerId: OrderByEnum` Id of the contact owner at the time of the event.
- `unitId: OrderByEnum` Id of the sales unit.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateContactKPIInput (input)

Field values of a new ContactKPI 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).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `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.
- `contactId: ID!` Id of the contact this KPI event relates to.
- `kpi: ContactKpiEnum!` KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified.
- `ownerId: ID!` Id of the contact owner at the time of the event.
- `unitId: ID` Id of the sales unit.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateContactKPIInput (input)

Field values of a ContactKPI record to create, or to update when its id is set.

- `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.
- `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.
- `contactId: ID` Id of the contact this KPI event relates to.
- `kpi: ContactKpiEnum` KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified.
- `ownerId: ID` Id of the contact owner at the time of the event.
- `unitId: ID` Id of the sales unit.
- `revision: Int` Revision when entity was lastly changed.

### DeleteContactKPIInput (input)

Id of the ContactKPI record to delete.

- `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.

### UpdateContactKPIInput (input)

Id of a ContactKPI record and the field values to change.

- `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.
- `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.
- `contactId: ID` Id of the contact this KPI event relates to.
- `kpi: ContactKpiEnum` KPI metric this event represents: CreateContact, FirstEmailSent, LastEmailSent, Archive or LastModified.
- `ownerId: ID` Id of the contact owner at the time of the event.
- `unitId: ID` Id of the sales unit.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateContactKPIPayload (object)

Result of the bulkUpdateContactKpi mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateContactKPIPayload (object)

Result of the createContactKpi mutation.

- `contactKpi: ContactKPIEntity` 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).

### DeleteContactKPIPayload (object)

Result of the deleteContactKpi mutation.

- `contactKpi: ContactKPIEntity` 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).

### UpdateContactKPIPayload (object)

Result of the updateContactKpi mutation.

- `contactKpi: ContactKPIEntity` 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).

### ContactKpiEnum (enum)

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

- `CreateContact` The contact was created.
- `LastEmailSent` The most recent email was sent to the contact.
- `FirstEmailSent` The first email was sent to the contact.
- `Archive` The contact was archived; the entry is removed when it is unarchived.
- `LastModified` The contact was last modified.

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstContactKPIs {
  entities {
    contactKpi {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}
```

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