SCALAR
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- AddChannelContentInputInput type for addChannelContent mutation. For additional information regarding content types please see: https://help.pluralsight.com/help/creating-your-first-channel
- AddChannelInputA type that describes the input for the AddChannel mutation.
- AddChannelMembersInputA type that describes the input for the AddChannelMember mutation.
- AddChannelMembersPayloadA type that describes the returned payload from the AddChannelMember mutation.
- AddRoleInputA type that describes an input for the AddRole mutation.
- AddTeamInputInput type for addTeam mutation.
- AddTeamManagerInputAn input type for adding a manager to a team using the 'addTeamManager' mutation. permissionLevel OR permissionSetId is required.
- AddTeamManagerPayloadReturn type for addTeamManager mutation.
- AddTeamMemberInputInput type for addTeamMember mutation.
- AddTeamMemberPayloadReturn type for addTeamMember mutation.
- AddTeamPayloadReturn type for addTeam mutation.
- AddTeamsToChannelsInputA type that describes the input for the addTeamsToChannels mutation.
- AddTeamsToChannelsPayloadA type that describes the returned payload from the addTeamsToChannels mutation.
- AdminA type that describes the Admin. An Admin has special permissions to edit plan details and to create API keys.
- AdminEdgeA type that describes an edge in the 'AdminConnection'. Essentially, a 'AdminEdge' is a wrapper object for 'Admin'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'Admin' records after 'cursor'.
- ArchiveChannelInputInput type for archiveChannel mutation.
- ArchiveChannelPayloadReturn type for archiveChannel mutation.
- AssignTeamsToRoleInputA type that describes an input for the assignTeamsToRole mutation.
- AssignTeamsToRolePayloadA type that describes the returned payload from the assignTeamsToRole mutation
- AssignUsersToRoleInputA type that describes an input for the assignUsersToRole mutation.
- AssignUsersToRolePayloadA type that describes the returned payload from the assignUsersToRole mutation
- CancelInviteInputAn input type for canceling an invite, using the cancel invite mutation.
- CancelInvitePayloadReturn type for 'cancelInvite' mutation.
- ChannelA ChannelV2 is a collection of content like Courses, Paths, Projects, Guides, Interactive Courses, External Links, etc.
- ChannelContentA type that associates Content with a Channel. SPECIAL SYNTAX: This query requires special syntax to get all of the fields. An example of this can be viewed at https://developer.pluralsight.com/docs/graphql/examples. Example, if type value is skills-assessment, to get more details on the skill-assessment content, connect using one of the following: channelContent.id to link to skillAssessment.id and/or skillAssessmentResult.assessmentId and/or skillIqsSummary.skillId
- ChannelContentBaseThe Channel Content Base type contains the default field information for the Channel Content Interface. For Informational Purposes Only: Use channelContent to query the data
- ChannelContentDetailsInputA type that describes an input for the AddChannelContentDetails mutation. Only applicable for the 'EXTERNAL_LINK' content type.
- ChannelContentEdgeA type that describes an edge in the 'ChannelContentConnection'. Essentially, a 'ChannelContentEdge' is a wrapper object for 'ChannelContent'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'ChannelContent' records after 'cursor'
- ChannelContentFilterInput filter for channelContent query. All filters provided will exclude result set. ie providing channelId:"123" will return only ChannelContent entities with channelId "123"
- ChannelContentInputA type that describes an input for the AddChannelContent mutation.
- ChannelContentSectionThe details of the Section Content.
- ChannelContentSectionBaseThe Channel Content Section Base type contains the default field information for the Channel Content Section Interface. For Informational Purposes Only: Use 'content' within the type Section to query the data
- ChannelContentSectionInputA type that describes an input for the content field for AddChannelContent mutation with sections.
- ChannelContentTypeAndIdInputnull
- ChannelContentTypeAndIdPayloadnull
- ChannelEdgeA type that describes an edge in the ChannelV2Connection. Essentially, a ChannelV2Edge is a wrapper object for ChannelV2. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch ChannelV2 records after 'cursor'.
- ChannelFilterFilters out records based on values passed in for filter parameters.
- ChannelGroupA ChannelGroup.
- ChannelGroupEdgeA type that describes an edge in the ChannelGroupConnection. Essentially, a ChannelGroupEdge is a wrapper object for ChannelGroup. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch ChannelGroup records after 'cursor'.
- ChannelGroupFilterInput filter for channelGroup query. All filters provided will be included in the result set.
- ChannelMemberA ChannelMembers is a User that has been assigned to the Channel.
- ChannelMemberEdgeA type that describes an edge in the ChannelMembersConnection. Essentially, a ChannelMembersEdge is a wrapper object for ChannelMembers. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch ChannelMembers records after 'cursor'.
- ChannelMemberFilterInput filter for channelMembers query. All filters provided will exclude result set. ie providing channelId:"123" will return only ChannelMember entities with channelId "123".
- ChannelProgressA ChannelProgress includes any user who has viewed content related to a channel, regardless of whether they are a channel member or not.
- ChannelProgressEdgeA type that describes an edge in the 'ChannelProgressConnection'. Essentially, a 'ChannelProgressEdge' is a wrapper object for 'ChannelProgress'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'ChannelProgress' records after 'cursor'
- ChannelProgressFilterInput filter for channelProgress query. All filters provided will exclude result set. ie providing userId:"test" and channelId:"test" will return only ChannelProgress entities with "test" in both userId AND channelId fields.
- ChannelTeamInputnull
- ChannelTeamPayloadnull
- ContentCatalogContent catalog data which includes the following content type: video courses, interactive courses, guides, paths and projects. This enitity is currently in BETA and will require your API KEY to have BETA access.
- ContentCatalogEdgeA type that describes an edge in the 'ContentCatalogConnection'. Essentially, a 'ContentCatalogEdge' is a wrapper object for 'ContentCatalog'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'InteractiveCourse' records after 'cursor'
- ContentCatalogFilterFilter parameters to reduce content catalog result sets by provided filters.
- ContentProgressContent progress data which includes the following content type: video courses, interactive courses, guides, paths and projects. This enitity is currently in BETA and will require your API KEY to have BETA access.
- ContentProgressEdgeA type that describes an edge in the 'ContentProgressConnection'. Essentially, a 'ContentProgressEdge' is a wrapper object for 'ContentProgress'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'InteractiveCourse' records after 'cursor'
- ContentSlugToIdInputnull
- ContentSlugToIdMapnull
- CourseMain type that represents Course catalog data, video courses only.
- CourseCatalogFilterFilter parameters to reduce course catalog result sets by provided filters.
- CourseDailyUsageRepresents user course usage totals for each day the user incurred usage, broken down per user, per course, per day by plan. i.e. If a user watched 30 minutes of a course on Monday morning and then again 30 mintues of the same course on Monday afternoon, one records will be created for the user with Monday's date reflected in 'rollupDate' with the daily aggregate of total watched time in 'clipViewSeconds' as 1 hour. If another user did the same thing, but watched a different course in the afternoon, two records will be created for a given user with the same 'rollupDate', the only difference between the two records will be the 'courseId'. See https://help.pluralsight.com/help/analytics-before-joining-plan for more information on how course analytics is affecting by learners joining and leaving plans.
- CourseDailyUsageEdgeA type that describes an edge in the CourseDailyUsageConnection. Essentially, a CourseDailyUsageEdge is a wrapper object for CourseDailyUsage. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CourseDailyUsage records after 'cursor'.
- CourseDailyUsageFilterInput filter for the 'CourseDailyUsage' query. All filters provided will narrow the result set.
- CourseEdgeA type that describes an edge in the 'CourseConnection'. Essentially, a 'CourseEdge' is a wrapper object for 'Course'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'Course' records after 'cursor'
- CourseProgressCourseProgress provides your plan members course usage data, including current and previous licensed users. These data snapshots can help in getting: - course progress and completion percentages of individual learners. - durations and user completion data for a particular course.
- CourseProgressEdgeA type that describes an edge in the CourseProgressConnection. Essentially, a CourseProgressEdge is a wrapper object for CourseProgress. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CourseProgress records after 'cursor'.
- CourseProgressFilterInput filter for the 'CourseProgress' query. All filters provided will narrow the result set. If the afterDate & beforeDate filters are used to get daily/delta reports, please be aware that you might miss offline usage data; Offline content when synced up, uses the actual course usage/viewing date for *ViewedClipOn dates and not usage sync up date.
- CrAssessmentFormLevelStatisticsA CrAssessmentFormLevelStatistics contains statistics about the scores (from each user's first regular assessment session only) for a given form.
- CrAssessmentFormLevelStatisticsEdgeA type that describes an edge in the CrAssessmentFormLevelStatisticsConnection. Essentially, a CrAssessmentFormLevelStatisticsEdge is a wrapper object for CrAssessmentFormLevelStatistics. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CrAssessmentFormLevelStatistics records after 'cursor'.
- CrAssessmentItemLevelStatisticsA CrAssessmentItemLevelStatistics contains statistics about the scores (from each user's first regular assessment session only) for a given item.
- CrAssessmentItemLevelStatisticsEdgeA type that describes an edge in the CrAssessmentItemLevelStatisticsConnection. Essentially, a CrAssessmentItemLevelStatisticsEdge is a wrapper object for CrAssessmentItemLevelStatistics. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CrAssessmentItemLevelStatistics records after 'cursor'.
- CrAssessmentOptionLevelStatisticsA CrAssessmentOptionLevelStatistics contains statistics about the scores (from each user's first regular assessment session only) for a given item.
- CrAssessmentOptionLevelStatisticsEdgeA type that describes an edge in the CrAssessmentOptionLevelStatisticsConnection. Essentially, a CrAssessmentOptionLevelStatisticsEdge is a wrapper object for CrAssessmentOptionLevelStatistics. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CrAssessmentOptionLevelStatistics records after 'cursor'.
- CrAssessmentUserCompletionA CrAssessmentUserCompletion represents a User completing a single topic within a criterion assessment.
- CrAssessmentUserCompletionEdgeA type that describes an edge in the CrAssessmentUserCompletionConnection. Essentially, a CrAssessmentUserCompletionEdge is a wrapper object for CrAssessmentUserCompletion. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CrAssessmentUserCompletion records after 'cursor'.
- CrAssessmentUserCompletionFilternull
- CrAssessmentUserOptionA CrAssessmentUserOption is the score of an instance of a User taking a criterion assessment. Incomplete sessions are included|excluded from this data.
- CrAssessmentUserOptionEdgeA type that describes an edge in the CrAssessmentUserOptionConnection. Essentially, a CrAssessmentUserOptionEdge is a wrapper object for CrAssessmentUserOption. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CrAssessmentUserOption records after 'cursor'.
- CrAssessmentUserOptionFilternull
- CrAssessmentUserScoreA CrAssessmentUserScore is the score of an instance of a User taking a criterion assessment.
- CrAssessmentUserScoreEdgeA type that describes an edge in the CrAssessmentUserScoreConnection. Essentially, a CrAssessmentUserScoreEdge is a wrapper object for CrAssessmentUserScore. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch CrAssessmentUserScore records after 'cursor'.
- CreateUserInputAn input type for creating a user, using the create user mutation.
- CreateUserPayloadReturn type for 'createUser' mutation.
- DeleteTeamInputInput type for deleteTeam mutation.
- DeleteTeamPayloadReturn type for deleteTeam mutation.
- EditChannelInputInput type for editChannel mutation.
- EditChannelPayloadnull
- EditRoleInputA type that describes an input for the EditRole mutation.
- EditTeamInputInput type for editTeam mutation.
- EditTeamPayloadReturn type for editTeam mutation.
- EditUserInputInput type for editUser mutation.
- EditUserPayloadReturn type for editUser mutation.
- ExternalLinkAn External Link type contains specific fields relating to the External Link data.
- ExternalLinkSectionAn External Link Section type contains specific fields relating to the External Link data contained within a unique section.
- ImageImage info about the given Course.
- InteractiveCourseRepresents an InteractiveCourse entity
- InteractiveCourseEdgeA type that describes an edge in the 'InteractiveCourseConnection'. Essentially, a 'InteractiveCourseEdge' is a wrapper object for 'InteractiveCourse'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'InteractiveCourse' records after 'cursor'
- InteractiveCourseFilterFilter parameters to reduce interactive course result sets by provided filters. Important note: 'name' and 'description' filters are additive, meaning that if I set name = 'javascript' and description = 'javascript', only records with 'javascript' in the 'name' AND 'description' will be returned.
- InteractiveCourseUrlsInteractiveCourseUrl's represent links to additional information about the InteractiveCourse
- InviteMemberInputAn input type for inviting a member, using the inviteMember mutation.
- InviteMemberPayloadReturn type for inviteMember mutation.
- ManagerA Manager is a User who has additional rights to manage a Team. For more details on Team Manager, please see: https://help.pluralsight.com/help/permissions-levels-for-team-managers
- ManagerEdgeA type that describes an edge in the ManagerConnection. Essentially, a ManagerEdge is a wrapper object for Manager. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch Manager records after 'cursor'.
- MemberInviteA MemberInvite represents a plan invitation sent to a Pluralsight user.
- MemberInviteEdgeA type that describes an edge in the MemberInviteConnection. Essentially, a MemberInviteEdge is a wrapper object for MemberInvite. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch MemberInvite records after 'cursor'.
- MemberInviteFilterInput filter for the 'MemberInvite' query. All filters provided will narrow the result set.
- Metricnull
- MoveMemberInputAn input type for moving a User to a different Team using the 'moveMemberToTeam' mutation.
- MoveMemberPayloadReturn type for 'moveMember' mutation.
- PageInfoInformation about if there is another page and how to get a next page if it exists on a given query.
- PathMain type that represents Path catalog data.
- PathContentProvides basic information about content in a Path.
- PathEdgeA type that describes an edge in the PathConnection. Essentially, a PathEdge is a wrapper object for Path. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch Path records after 'cursor'.
- PathLevelProvides information about the Levels of a given Path.
- PlanAdminA PlanAdmin has special permissions to edit plan details and to create API keys.
- PlanAdminEdgeA type that describes an edge in the PlanAdminConnection. Essentially, a PlanAdminEdge is a wrapper object for PlanAdmin. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch PlanAdmin records after 'cursor'.
- PlanPermissionSetA PlanPermissionSet is a custom permission model for what managers and admins have permissions for on a plan. There are 4 standard permission sets available to all plans. Custom permission sets may exist.
- PrimaryAtomicRepresents the Primary Atomic.
- PriorityA Priority.
- PriorityEdgeA type that describes an edge in the PriorityConnection. Essentially, a PriorityEdge is a wrapper object for Priority. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch Priority records after 'cursor'.
- PriorityFilterInput filter for priority query. All filters provided will be included in the result set.
- QueryQueries are read only graphQL APIs that allow access to your data. The following advanced analytics APIs are available only to Enterprise plans: channelProgress, SkillAssessmentResult(s) and roleIqLearnerLevels.
- RemoveChannelContentInputInput type for removeChannelContent mutation. For additional information regarding content types please see: https://help.pluralsight.com/help/creating-your-first-channel
- RemoveChannelContentPayload"Return type for removeChannelContent mutation."
- RemoveChannelMemberInputA type that describes the input for the RemoveChannelMember mutation. You can remove yourself or if you are the editor or owner you can remove others.
- RemoveChannelMemberPayloadA type that describes the returned payload from the RemoveChannelMember mutation.
- RemoveTeamManagerInputAn input type for removing a manager from a team using the removeTeamManager mutation.
- RemoveTeamManagerPayloadReturn type for removeTeamManager mutation.
- RemoveTeamMemberInputInput type for removeTeamMember mutation.
- RemoveTeamMemberPayloadReturn type for removeTeamMember mutation.
- RemoveUserInputAn input type for removing a user, using the remove user mutation.
- RemoveUserPayloadReturn type for 'removeUser' mutation.
- RoleIqA Role IQ represents a container of skills that define a particular Role.
- RoleIqAssignmentAssignments represent Role IQ's that have been assigned to a particular user
- RoleIqAssignmentEdgeA type that describes an edge in the 'RoleIqAssignmentConnection'. Essentially, a 'RoleIqAssignmentEdge' is a wrapper object for 'RoleIqAssignment'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'RoleIqAssignment' records after 'cursor'
- RoleIqAssignmentFilterFilter parameters to reduce result sets by provided filters.
- RoleIqCatalogFilterFilter parameters to reduce result sets by provided filters.
- RoleIqEdgeA type that describes an edge in the 'RoleIqConnection'. Essentially, a 'RoleIqEdge' is a wrapper object for 'RoleIq'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'RoleIq' records after 'cursor'
- RoleIqLearnerLevelThe level of an individual learner's role
- RoleIqLearnerLevelEdgeA type that describes an edge in the 'LearnerLevelConnection'. Essentially, a 'LearnerLevelEdge' is a wrapper object for 'LearnerLevel'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'LearnerLevel' records after 'cursor'
- RoleIqLearnerLevelFilterFilter parameters to reduce the result set.
- RoleIqSkillRole IQ Skills represent the particular skills associated with a Role IQ.
- RoleIqSkillEdgeA type that describes an edge in the 'RoleIqSkillConnection'. Essentially, a 'RoleIqSkillEdge' is a wrapper object for 'RoleIqSkill'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'RoleIqSkill' records after 'cursor'
- RoleIqSkillFilterFilter parameters to reduce result sets by provided filters.
- RoleIqsSummaryA RoleIqsSummary is a summary view of roles for your organization.
- RoleIqsSummaryEdgeA type that describes an edge in the 'RoleIqsSummaryConnection'. Essentially, a 'RoleIqsSummaryEdge' is a wrapper object for 'RoleIqsSummary'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'RoleIqsSummary' records after 'cursor'.
- RoleIqsSummaryFilterFilter parameters to reduce result sets by provided filters.
- SectionA Section represents a particular Content Type that contains additional Content except sections.
- SkillAssessmentA SkillAssessment represents a capability for which a Skill Assessment can be taken by a User to achieve a SkillIq.
- SkillAssessmentEdgeA type that describes an edge in the 'SkillAssessmentConnection'. Essentially, a 'SkillAssessmentEdge' is a wrapper object for 'SkillAssessment'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'SkillAssessment' records after 'cursor'.
- SkillAssessmentResultSkillAssessmentResult is the result of an assessment taken by a User. Once the assessment is completed, a User has 48 hours to complete a do-over if they would like. The higher of the two scores is kept. The User can retake a Skill assessment every 30 days or after they have consumed 60% of a Path level. Unlike do-overs, the new SkillIq is the new score regardless of whether it is higher or lower. For more details, please see https://help.pluralsight.com/help/how-can-i-re-measure-my-skill-iq
- SkillAssessmentResultEdgeA type that describes an edge in the 'SkillAssessmentResultConnection'. Essentially, a 'SkillAssessmentResultEdge' is a wrapper object for 'SkillAssessmentResult'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'SkillAssessmentResult' records after 'cursor'.
- SkillAssessmentResultFilterFilter parameters to reduce result sets by provided filters.
- SkillIqsSummaryA SkillIqsSummary is a summary view of skill levels for your organization.
- SkillIqsSummaryEdgeA type that describes an edge in the 'SkillIqsSummaryConnection'. Essentially, a 'SkillIqsSummaryEdge' is a wrapper object for 'SkillIqsSummary'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'SkillIqsSummary' records after 'cursor'.
- SkillIqsSummaryFilterFilter parameters to reduce result sets by provided filters.
- StatusStatus info about the given Course.
- SubTopicA SkillAssessment SubTopic: further information on items that the assessment Topic may cover.
- Tagsnull
- TagsEdgenull
- TeamA Team is a grouping of Users. A User can belong to many Teams. For more details on teams please see https://help.pluralsight.com/help/how-do-i-create-a-team
- TeamEdgeA type that describes an edge in the 'TeamConnection'. Essentially, a 'TeamEdge' is a wrapper object for 'Team'. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch 'Team' records after 'cursor.'
- TeamManagerA TeamManager is a plan user who has additional rights to manage a Team. For more details on TeamManager, please see: https://help.pluralsight.com/help/permissions-levels-for-team-managers
- TeamManagerEdgeA type that describes an edge in the TeamManagerConnection. Essentially, a TeamManagerEdge is a wrapper object for TeamManager. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch TeamManager records after 'cursor'.
- TeamsFilterInput filter for 'teams' query. All filters provided will exclude result set. ie providing name:"test" and description:"test" will return only teams with "test" in both name AND description fields
- TopicA SkillAssessment Topic: items that the assessment may cover.
- UnassignMemberInputAn input type for unassigning a User from any Team using the 'unassignMemberFromTeam' mutation.
- UnassignMemberPayloadReturn type for 'moveMemberToTeam' query.
- UserA User on Pluralsight is someone who is currently using or has ever used a license on the plan. Users may also be team managers or plan admins with a license.
- UserEdgeA type that describes an edge in the UserConnection. Essentially, a UserEdge is a wrapper object for User. The only addition is a cursor placed on each record that can be used in subsequent queries to fetch User records after 'cursor'.
- UserFilterInput filter for the 'User' query. All filters provided will narrow the result set.
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __SchemaA GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name, description and optional `specifiedByUrl`, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.