Customer Education (CE) Objects

Object Glossary for Gainsight's Customer Education (CE) Connector

This comprehensive glossary now includes a wide range of objects and their fields, providing a detailed and thorough overview of the data structures involved in the integration between Customer Education (FKA Northpass) and Gainsight's CS Connectors. Each object serves a specific role in managing and tracking educational activities and user interactions on the platform. Each table aims to offer clarity on the purpose and usage of various fields within the integration process.

Object Display Name	Object Name	Description	Object Type
CE Certificate	Certificate	A certificate awarded for completing a course or learning path.	SYSTEM
CE Certificate Achievement	CertificateAchievement	An achievement record indicating a learner has earned a certificate.	SYSTEM
CE Course	Course	A course offered within the Customer Education platform.	SYSTEM
CE Learner	Learner	A learner in Customer Education.	SYSTEM
CE Learning Path	LearningPath	A series of courses or ILT events designed to achieve specific learning objectives within Customer Education.	SYSTEM
CE Learning Path Item	LearningPathItem	Individual courses or instructor-led trainings (ILTs) that are part of a learning path.	SYSTEM
CE Learning Progress	learningprogress	Analytics and tracking of learner's progress through courses and learning paths.	SYSTEM
CE School	school	Information and details about Customer Education.	SYSTEM
CE Training Event	TrainingEvent	An instructor-led training event within the Customer Education platform.	SYSTEM
CE Training Session	TrainingSession	A specific session within a training event.	SYSTEM

CE Certificate

Represents a credential awarded to learners for completing a course or learning path. It includes fields like expiration date, issuer name, and so on as listed in the table below.

Name	Field Name	Description	Data Type
Number Of Days Until Expiration	NumberOfDaysUntilExpiration	The number of days the certificate is valid after issuance.	number
GS Created Date	CreatedDate	The date and time when the record was created.	dateTime
GS Modified By	ModifiedBy	The ID of the user who last modified the record.	gsid
Created At	CreatedAt	The timestamp indicating when the credential was created.	dateTime
Credential Id	ExternalId	A unique identifier for the credential.	string
Is Public	IsPublic	Indicates whether the credential is publicly visible.	boolean
Name	Name	The name of the credential	string
Is Recertification	IsRecertification	Indicates whether the credential can be renewed or reissued.	boolean
Is Revoked After Expiring	IsRevokedAfterExpiring	Indicates whether the credential is revoked after its expiration date.	boolean
Updated At	UpdatedAt	The timestamp indicating the last time the credential record was updated.	dateTime
Issuer Name	IssuerName	The name of the entity that issued the credential.	string
GS Created By	CreatedBy	The ID of the user who created the record in Gainsight.	gsid
GSID	Gsid	The Gainsight ID for the record.	gsid
GS Modified Date	ModifiedDate	The date and time when the credential record was last modified.	dateTime
School Id	SchoolId	The ID linking to the school associated with the credential.	string

CE Certificate Achievement

Tracks achievements of learners in earning certificates. It includes fields like the learner ID, expiration date of the certificate, the URL for credential download and so on as listed in the table below.

Name	Field Name	Description	Data Type
Criteria Id	CriteriaId	This ID links references either the course or the learning path that the learner completed to achieve this certificate.	string
Updated At	UpdatedAt	The timestamp indicates when the record was last updated.	dateTime
GS Modified Date	ModifiedDate	The date and time when the record was last modified.	dateTime
School Id	SchoolId	The ID links to the school associated with the achievement.	string
Expires At	ExpiresAt	The date and time when the certificate will expire.	dateTime
GS Modified By	ModifiedBy	The ID of the user who last modified the record in Gainsight.	gsid
GS Created By	CreatedBy	The ID of the user who created the record in Gainsight.	gsid
Learner Id	LearnerId	The ID of the learner who earned the achievement.	string
Download Url	DownloadUrl	URL for the Certificate Verification Page	url
Created At	CreatedAt	The timestamp that indicates when the record was created.	dateTime
Credential Id	CredentialId	The ID of the credential associated with the achievement.	string
CredentialAchievement Id	ExternalId	A unique identifier for credential achievement.	string
GSID	Gsid	The Gainsight ID associated with the achievement.	gsid
Criteria Type	CriteriaType	Indicates the type of content a Learner must complete to earn a certification. Currently, two content types are supported for achieving certificates: Course and Learning Path.	string
GS Created Date	CreatedDate	The date and time when the record was created.	dateTime

CE Course

Represents an individual course within the Customer Education platform. It includes fields such as course name, description, price, status and so on as listed in the table below.

Name	Field Name	Description	Data Type
Credential Id	CredentialId	The ID of a certificate associated with the course.	string
For Sale	ForSale	Indicates whether the course is available for sale.	boolean
Price Cents	PriceCents	The price of the course in cents.	number
Updated At	UpdatedAt	The timestamp that indicates when the record was last updated.	dateTime
Short Description	ShortDescription	A brief description of the course.	richTextArea
GS Modified By	ModifiedBy	The ID of the user who last modified the course record in Gainsight.	gsid
Enrollment Code	EnrollmentCode	The code used for enrolling in the course.	string
Created At	CreatedAt	The timestamp indicates when the record was created.	dateTime
School Id	SchoolId	The ID linking to the school object associated with the course.	string
Enrollments Count	EnrollmentsCount	The total number of enrollments in the course.	number
Promo Video Embed Url	PromoVideoEmbedUrl	The URL of a promotional video that can be embedded in the course.	string
Full Description	FullDescription	A detailed description of the course.	richTextArea
Permalink	Permalink	A permanent shortcut link for the course.	string
Status	Status	The current status of the course (example, active, inactive).	string
GSID	Gsid	The Gainsight ID associated with the course.	gsid
GS Modified Date	ModifiedDate	The date and time when the record was last modified.	dateTime
GS Created Date	CreatedDate	The date and time when the course record was created.	dateTime
Course Id	ExternalId	A unique identifier for the course.	string
Name	Name	The name of the course.	string
GS Created By	CreatedBy	The ID of the user who created the record in Gainsight.	gsid

CE Learner

Represents a learner within the Customer Education platform. It includes fields such as learner ID, email, sign-in timestamps, status, and so on as listed in the table below.

Name	Field Name	Description	Data Type
Last Name	LastName	The last name of the learner.	string
GS Created Date	CreatedDate	The date and time when the learner record was created in Gainsight.	dateTime
Updated At	UpdatedAt	The timestamp indicates when the learner record was last updated.	dateTime
Current Sign In At	CurrentSignInAt	The timestamp of the learner's current sign-in session.	dateTime
Email	Email	The email address of the learner.	email
Unsubscribed At	UnsubscribedAt	The timestamp when the learner unsubscribed from communications.	dateTime
Last Invite Sent At	LastInviteSentAt	The timestamp when the last invitation was sent to the learner.	dateTime
Learner Id	ExternalId	A unique identifier for the learner.	string
Is Deactivated	IsDeactivated	Indicates if the learner is deactivated.	boolean
Sso Uid	SsoUid	The ID of the learner from the SSO provider.	string
GSID	Gsid	The Gainsight ID associated with the learner.	gsid
Activated At	ActivatedAt	The timestamp when the learner account was activated.	dateTime
Person	Person	A mapping to the person object in Gainsight.	gsid
Created At	CreatedAt	The timestamp indicating when the learner record was created.	dateTime
Last Sign In At	LastSignInAt	The timestamp of the learner's last sign-in session.	dateTime
GS Modified By	ModifiedBy	The ID of the user who last modified the learner record in Gainsight.	gsid
Phone Number	PhoneNumber	The phone number of the learner, if provided.	string
Company Person	CompanyPerson	A mapping to the company person object in Gainsight.	gsid
First Name	FirstName	The first name of the learner.	string
Name	Name	The full name of the learner.	string
School Id	SchoolId	The ID linking to the school object associated with the learner.	string
GS Created By	CreatedBy	The ID of the user who created the learner record in Gainsight.	gsid
GS Modified Date	ModifiedDate	The date and time when the learner record was last modified.	dateTime
Company	Company	A mapping to the company object in Gainsight.	gsid
Sign In Count	SignInCount	The total number of times the learner has signed in.	number

CE Learning Path

Represents a structured path of courses and ILTs designed to achieve a specific learning objective. It includes fields like learning path name, description, associated credential ID, and so on as listed in the table below.

Name	Field Name	Description	Data Type

Navigation Mode	NavigationMode	The navigation mode of the learning path, defining how learners progress through it.	string
GSID	Gsid	The Gainsight ID associated with the learning path.	gsid
GS Modified Date	ModifiedDate	The date and time when the learning path record was last modified.	dateTime
Updated At	UpdatedAt	The timestamp that indicates when the learning path record was last updated.	dateTime
School Id	SchoolId	The ID linking to the school object associated with the learning path.	string
LearningPath Id	ExternalId	A unique identifier for the learning path.	string
Credential Id	CredentialId	The ID of a credential associated with the learning path.	string
Name	Name	The name of the learning path.	string
Created At	CreatedAt	The timestamp that indicates when the learning path record was created.	dateTime
GS Modified By	ModifiedBy	The ID of the user who last modified the learning path record in Gainsight.	gsid
GS Created By	CreatedBy	The ID of the user who created the learning path record in Gainsight.	gsid
Discarded At	DiscardedAt	The timestamp indicating when the learning path was discarded.	dateTime
Description	Description	A brief description of the learning path.	string
GS Created Date	CreatedDate	The date and time when the learning path record was created.	dateTime

CE Learning Path Item

Represents individual items within a learning path, such as courses or training events. It includes fields like the item ID, position in the learning path, and whether the item is optional and so on as listed in the table below.

Name	Field Name	Description	Data Type
GS Created Date	CreatedDate	The date and time when the learning path item record was created.	dateTime
GS Modified By	ModifiedBy	The ID of the user who last modified the learning path item record in Gainsight.	gsid
Resource Id	ResourceId	The ID of the item in the learning path, either a course or a training event.	whatId
GS Created By	CreatedBy	The ID of the user who created the learning path item record in Gainsight.	gsid
GS Modified Date	ModifiedDate	The date and time when the learning path item record was last modified.	dateTime
Position	Position	The position of the resource within the learning path.	number
Updated At	UpdatedAt	The timestamp indicating when the learning path item record was last updated.	dateTime
Learning Path Id	LearningPathId	The ID of the learning path to which this item belongs.	string
GSID	Gsid	The Gainsight ID associated with the learning path item.	gsid
LearningPathItem Id	ExternalId	A unique identifier for the learning path item.	string
Created At	CreatedAt	The timestamp indicating when the learning path item record was created.	dateTime
Is Optional	IsOptional	Indicates whether completing the resource is mandatory to finish the learning path.	boolean
School Id	SchoolId	The ID linking to the school object associated with the learning path item.	string

CE Learning Progress

The CE Learning Progress object tracks the progress of learners through courses and learning paths. This is the most important object for CS activities since it contains the information of who is learning what and how much did they progress. It contains a row for each course enrollment and additional rows for each attempt that the user has for that course enrollment. Training Event enrollments will have only one row. It includes fields like learner ID, course ID, progress percentage, timestamps for enrollment and completion, and more, as detailed in the table below.

Name	Field Name	Description	Data Type
School Id	SchoolId	The unique ID of the school.	string
Learner Id	LearnerId	The unique ID of the learner.	string
Education Mode	EducationMode	The type or mode of the education; the options include Course, Learning Path, or Training Event.	string
Course Id	CourseId	The unique Id of the course.	string
Learning Path Id	LearningPathId	The unique ID of the learning path.	string
Training Event Id	TrainingEventId	The unique ID of the training event.	string
Enrollment Source	EnrollmentSource	The method or source through which the learner was enrolled in the course.	string
Enrolled At	EnrolledAt	The timestamp that indicates when the learner was enrolled.	dateTime
Attempt Number	AttemptNumber	The number of attempts the learner has made for the course enrollment.	number
Is Last Attempt	IsLastAttempt	Indicates whether it is the last attempt for the given course and learner.	boolean
Started At	StartedAt	The timestamp indicating when the attempt began.	dateTime
Progress	Progress	The progress of the learner's attempt as a percentage.	percentage
Completed At	CompletedAt	The timestamp that indicates when the attempt was completed.	dateTime
Updated At	UpdatedAt	The timestamp that indicates when the record was last updated.	dateTime
Training Attendance	TrainingAttendance	Indicates whether the learner attended the training session	string
Training Session Id	TrainingSessionId	The unique ID of the training session.	string
Content Id	ExternalId	Unique identifier from all different sources.	string
Training Registration Status	TrainingRegistrationStatus	The registration status for the training.	string
Content Type	ContentType	The type of content	string
GSID	Gsid	The Gainsight ID associated with the learning progress record.	gsid
GS Modified Date	GsModifiedDate	The date and time when the record was last modified in Gainsight.	dateTime
GS Modified By	GsModifiedBy	The ID of the user who last modified the record in Gainsight.	string
GS Created Date	GsCreatedDate	The date and time when the record was created in Gainsight.	dateTime
GS Created By	GsCreatedBy	The ID of the user who created the record in Gainsight.	string

CE School

Represents a school or educational institution within the Customer Education platform. It includes fields like school ID, name, domain, admin contact information, and so on as detailed in the table below..

Name	Field Name	Description	Data Type
School Id	SchoolId	The unique ID associated with each school or academy.	string
Type	Type	The type or category of the school.	string
Description	Description	A brief description of the school.	string
Name	Name	The name of the school.	string
Domain	Domain	The domain or web address of the school.	string
Admin Url	AdminUrl	The URL for the school's administrative portal.	url
Admin Email	AdminEmail	Comma-separated list of admin email addresses.	string
GSID	Gsid	The Gainsight ID associated with the school.	gsid
GS Modified Date	GsModifiedDate	The date and time when the school record was last modified in Gainsight.	dateTime
GS Modified By	GsModifiedBy	The ID of the user who last modified the school record in Gainsight.	string
GS Created Date	GsCreatedDate	The date and time when the school record was created in Gainsight.	dateTime
GS Created By	GsCreatedBy	The ID of the user who created the school record in Gainsight.	string

CE Training Event

Represents an instructor-led training event. It includes fields like event type, visibility, time zone, associated school ID, and so on as listed in the table below.

Name	Field Name	Description	Data Type
GS Modified Date	ModifiedDate	The date and time when the training event record was last modified.	dateTime
Registration Type	RegistrationType	The type of registration for the training event.	string
GSID	Gsid	The Gainsight ID associated with the training event.	gsid
Updated At	UpdatedAt	The timestamp indicates when the training event record was last updated.	dateTime
School Id	SchoolId	The ID linking to the school object associated with the training event.	string
GS Created Date	CreatedDate	The date and time when the training event record was created.	dateTime
Event Type	EventType	The type of instructor-led training (ILT) event.	string
GS Created By	CreatedBy	The ID of the user who created the training event record in Gainsight.	gsid
Visibility	Visibility	Specifies who can see the training event.	string
Name	Name	The name of the training event.	string
GS Modified By	ModifiedBy	The ID of the user who last modified the training event record in Gainsight.	gsid
Description	Description	A brief description of the training event.	string
TrainingEvent Id	ExternalId	A unique identifier for the training event.	string
Created At	CreatedAt	The timestamp indicating when the training event record was created.	dateTime
Time Zone	TimeZone	The time zone in which the training event is held.	string

CE Training Session

Represents individual sessions within a training event. It includes fields like session ID, start and end times, associated training event ID, and so on as listed in the table below.

Name	Field Name	Description	Data Type
GSID	Gsid	The Gainsight ID associated with the training session.	gsid
School Id	SchoolId	The ID linking to the school object associated with the training session.	string
GS Modified By	ModifiedBy	The ID of the user who last modified the training session record in Gainsight.	gsid
Training Event Id	TrainingEventId	The ID of the training event to which this session belongs.	string
Ends At	EndsAt	The timestamp indicating when the training session ends (UTC, timezone is defined in the training event object).	dateTime
GS Created Date	CreatedDate	The date and time when the training session record was created.	dateTime
GS Modified Date	ModifiedDate	The date and time when the training session record was last modified.	dateTime
TrainingSession Id	ExternalId	A unique identifier for the training session.	string
Updated At	UpdatedAt	The timestamp indicating when the training session record was last updated.	dateTime
Starts At	StartsAt	The timestamp indicating when the training session starts (UTC, timezone is defined in the training event object).	dateTime
GS Created By	CreatedBy	The ID of the user who created the training session record in Gainsight.	gsid
Created At	CreatedAt	The timestamp indicating when the training session record was created.	dateTime