GraphQL RepositoriesactivityKpi

`entities.activityKpi`

Read activity KPI records with the activityKpi repository, and change them with the activity KPI mutations. Same records as the REST ActivityKPIs entity.

Example: first three activity KPI recordsGraphQLcURL

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

Queries

Fields of entities { activityKpi { … } }.

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.	ActivityKPIEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ActivityKPIEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ActivityKPIFilterInput, orderBy: [ActivityKPIOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ActivityKPIEntity!]!
QUERY	`getByCriteria`(filter: ActivityKPIFilterInput, orderBy: [ActivityKPIOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ActivityKPIEntityConnection
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	`createActivityKpi`(input: CreateActivityKPIInput!, validationLevel: [ValidationLevel!])	Create one record	CreateActivityKPIPayload
MUTATION	`updateActivityKpi`(input: UpdateActivityKPIInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateActivityKPIPayload
MUTATION	`bulkUpdateActivityKpi`(input: [CreateOrUpdateActivityKPIInput!]!, deleteInput: [DeleteActivityKPIInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateActivityKPIPayload
MUTATION	`deleteActivityKpi`(input: DeleteActivityKPIInput!)	Soft-delete	DeleteActivityKPIPayload

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.

ActivityKPIEntity object 18 fields: isDeleteProtected, id, isDeleted, …

Recorded KPI event of a task or an appointment, such as its creation or completion, 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.
`appointment`	AppointmentEntity	Appointment this KPI event relates to. Set when activityId resolves to an Appointment; otherwise empty.
`task`	TaskEntity	Task this KPI event relates to. Set when activityId resolves to a Task; otherwise empty.
`client`	ClientEntity	User who triggered the KPI event (e.g. created or completed the activity).
`owner`	ClientEntity	Activity owner at the time the KPI event occurred.
`unit`	SalesUnitEntity	Sales unit the triggering user belonged to at the time of the event.
`activityId`	ID!	Id of the appointment or task the 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`	ActivityKpiEnum!	KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified.
`ownerId`	ID	Id of the activity 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.

ActivityKPIEntityConnection object pageInfo: PageInfo!, edges: [ActivityKPIEntityEdge]!, totalCount: Int

Paginated list of ActivityKPI records.

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

ActivityKPIEntityEdge object node: ActivityKPIEntity, cursor: String!

A Relay edge containing a ActivityKPIEntity and its cursor.

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

ActivityKpiEnumFilterInput input eq: [ActivityKpiEnum!], NOT: ActivityKpiEnumFilterInput

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

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

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

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

Input field	Type	Description
`OR`	[ActivityKPIFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ActivityKPIFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ActivityKPIFilterInput	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.
`activityId`	EntityFilterStringField	Id of the appointment or task the 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`	ActivityKpiEnumFilterInput	KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified.
`ownerId`	EntityFilterStringField	Id of the activity owner at the time of the event.
`unitId`	EntityFilterStringField	Id of the sales unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`appointment`	AppointmentFilterInput	Appointment this KPI event relates to. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions.
`task`	TaskFilterInput	Task this KPI event relates to. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions.
`client`	ClientFilterInput	User who triggered the KPI event (e.g. created or completed the activity). Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	Activity 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.

ActivityKPIOrderByInput input Asc or Desc per field

Sorting of ActivityKPI 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.
`appointment`	[AppointmentOrderByNestedInput!]	Appointment this KPI event relates to. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`task`	[TaskOrderByNestedInput!]	Task this KPI event relates to. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`client`	[ClientOrderByNestedInput!]	User who triggered the KPI event (e.g. created or completed the activity). Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	Activity 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.
`activityId`	OrderByEnum	Id of the appointment or task the KPI event relates to.
`clientId`	OrderByEnum	Id of the user who triggered the event.
`ownerId`	OrderByEnum	Id of the activity owner at the time of the event.
`unitId`	OrderByEnum	Id of the sales unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new ActivityKPI 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.
`activityId`	ID!	Id of the appointment or task the 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`	ActivityKpiEnum!	KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified.
`ownerId`	ID	Id of the activity owner at the time of the event.
`unitId`	ID!	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an ActivityKPI 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.
`activityId`	ID	Id of the appointment or task the 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`	ActivityKpiEnum	KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified.
`ownerId`	ID	Id of the activity owner at the time of the event.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

DeleteActivityKPIInput input clientMutationId: String, id: ID!, activityId: ID

Id of the ActivityKPI 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.
`activityId`	ID	Id of the appointment or task the KPI event relates to.

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

Id of an ActivityKPI 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.
`activityId`	ID	Id of the appointment or task the 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`	ActivityKpiEnum	KPI metric this event represents: ActivityCreate, ActivityCompleted or LastModified.
`ownerId`	ID	Id of the activity owner at the time of the event.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateActivityKPIPayload object result: BulkUpdateResults!

Result of the bulkUpdateActivityKpi mutation.

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

CreateActivityKPIPayload object activityKpi: ActivityKPIEntity, clientMutationId: String

Result of the createActivityKpi mutation.

Field	Type	Description
`activityKpi`	ActivityKPIEntity	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).

DeleteActivityKPIPayload object activityKpi: ActivityKPIEntity, clientMutationId: String

Result of the deleteActivityKpi mutation.

Field	Type	Description
`activityKpi`	ActivityKPIEntity	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).

UpdateActivityKPIPayload object activityKpi: ActivityKPIEntity, clientMutationId: String

Result of the updateActivityKpi mutation.

Field	Type	Description
`activityKpi`	ActivityKPIEntity	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).

ActivityKpiEnum enum ActivityCreate, ActivityCompleted, LastModified

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

Value	Description
`ActivityCreate`	The activity was created.
`ActivityCompleted`	The activity was completed.
`LastModified`	The activity was last modified.