GraphQL RepositoriesprojectKpi

`entities.projectKpi`

Read project KPI records with the projectKpi repository, and change them with the project KPI mutations. Same records as the REST ProjectKPIs entity.

Example: first three project KPI recordsGraphQLcURL

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

Queries

Fields of entities { projectKpi { … } }.

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.	ProjectKPIEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ProjectKPIEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ProjectKPIFilterInput, orderBy: [ProjectKPIOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ProjectKPIEntity!]!
QUERY	`getByCriteria`(filter: ProjectKPIFilterInput, orderBy: [ProjectKPIOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ProjectKPIEntityConnection
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	`createProjectKpi`(input: CreateProjectKPIInput!, validationLevel: [ValidationLevel!])	Create one record	CreateProjectKPIPayload
MUTATION	`updateProjectKpi`(input: UpdateProjectKPIInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateProjectKPIPayload
MUTATION	`bulkUpdateProjectKpi`(input: [CreateOrUpdateProjectKPIInput!]!, deleteInput: [DeleteProjectKPIInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateProjectKPIPayload
MUTATION	`deleteProjectKpi`(input: DeleteProjectKPIInput!)	Soft-delete	DeleteProjectKPIPayload

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.

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

KPI event of a project (its completion), used in activity reporting.

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.
`client`	ClientEntity	User who triggered the KPI event (project completion).
`owner`	ClientEntity	Project owner at the time the KPI event occurred.
`project`	ProjectEntity	Project this KPI event relates to.
`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.
`kpi`	ProjectKpiEnum!	KPI metric this event represents: Create, ProjectCompleted or LastModified.
`ownerId`	ID!	Id of the project owner at the time of the event.
`projectId`	ID!	Id of the project this KPI event relates to.
`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.

ProjectKPIEntityConnection object pageInfo: PageInfo!, edges: [ProjectKPIEntityEdge]!, totalCount: Int

Paginated list of ProjectKPI records.

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

ProjectKPIEntityEdge object node: ProjectKPIEntity, cursor: String!

A Relay edge containing a ProjectKPIEntity and its cursor.

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

ProjectKpiEnumFilterInput input eq: [ProjectKpiEnum!], NOT: ProjectKpiEnumFilterInput

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

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

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

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

Input field	Type	Description
`OR`	[ProjectKPIFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ProjectKPIFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ProjectKPIFilterInput	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.
`kpi`	ProjectKpiEnumFilterInput	KPI metric this event represents: Create, ProjectCompleted or LastModified.
`ownerId`	EntityFilterStringField	Id of the project owner at the time of the event.
`projectId`	EntityFilterStringField	Id of the project this KPI event relates to.
`unitId`	EntityFilterStringField	Id of the sales unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User who triggered the KPI event (project completion). Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	Project owner at the time the KPI event occurred. Matches records where a related record meets these conditions.
`project`	ProjectFilterInput	Project this KPI event relates to. 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.

ProjectKPIOrderByInput input Asc or Desc per field

Sorting of ProjectKPI 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.
`client`	[ClientOrderByNestedInput!]	User who triggered the KPI event (project completion). Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	Project owner at the time the KPI event occurred. Sorts by fields of the related record, listed in order of priority.
`project`	[ProjectOrderByNestedInput!]	Project this KPI event relates to. 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.
`ownerId`	OrderByEnum	Id of the project owner at the time of the event.
`projectId`	OrderByEnum	Id of the project this KPI event relates to.
`unitId`	OrderByEnum	Id of the sales unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a ProjectKPI 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.
`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`	ProjectKpiEnum	KPI metric this event represents: Create, ProjectCompleted or LastModified.
`ownerId`	ID	Id of the project owner at the time of the event.
`projectId`	ID	Id of the project this KPI event relates to.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of a new ProjectKPI 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.
`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`	ProjectKpiEnum!	KPI metric this event represents: Create, ProjectCompleted or LastModified.
`ownerId`	ID!	Id of the project owner at the time of the event.
`projectId`	ID!	Id of the project this KPI event relates to.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

DeleteProjectKPIInput input clientMutationId: String, id: ID!

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

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

Id of a ProjectKPI 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.
`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`	ProjectKpiEnum	KPI metric this event represents: Create, ProjectCompleted or LastModified.
`ownerId`	ID	Id of the project owner at the time of the event.
`projectId`	ID	Id of the project this KPI event relates to.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateProjectKPIPayload object result: BulkUpdateResults!

Result of the bulkUpdateProjectKpi mutation.

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

CreateProjectKPIPayload object projectKpi: ProjectKPIEntity, clientMutationId: String

Result of the createProjectKpi mutation.

Field	Type	Description
`projectKpi`	ProjectKPIEntity	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).

DeleteProjectKPIPayload object projectKpi: ProjectKPIEntity, clientMutationId: String

Result of the deleteProjectKpi mutation.

Field	Type	Description
`projectKpi`	ProjectKPIEntity	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).

UpdateProjectKPIPayload object projectKpi: ProjectKPIEntity, clientMutationId: String

Result of the updateProjectKpi mutation.

Field	Type	Description
`projectKpi`	ProjectKPIEntity	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).

ProjectKpiEnum enum ProjectCompleted, Create, LastModified

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

Value	Description
`ProjectCompleted`	The project was completed.
`Create`	The project was created.
`LastModified`	The project was last modified.