OBJECT

ActivityKPIEntity

Recorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports.

link GraphQL Schema definition

  • type ActivityKPIEntity {
  • # 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.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Appointment this KPI event relates to. Set when activityId resolves to an
  • # Appointment; otherwise empty.
  • appointment: AppointmentEntity
  • # Task this KPI event relates to. Set when activityId resolves to a Task;
  • # otherwise empty.
  • task: TaskEntity
  • # User who triggered the KPI event (e.g. created or completed the activity).
  • client: ClientEntity
  • # Activity owner at the time the KPI event occurred.
  • owner: ClientEntity
  • # Sales unit the triggering user belonged to at the time of the event.
  • unit: SalesUnitEntity
  • # Id of the appointment or task the KPI event relates to.
  • activityId: ID!
  • # Application context in which the KPI event was triggered (e.g. browser,
  • # automation, third-party integration).
  • applicationId: ID
  • # Id of the user who triggered the event.
  • clientId: ID
  • # KPI metric this event represents: ActivityCreate, ActivityCompleted or
  • # LastModified.
  • kpi: ActivityKpiEnum!
  • # Id of the activity owner at the time of the event.
  • ownerId: ID
  • # Id of the sales unit.
  • unitId: ID!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by