Changelog

The GraphQL schema change log is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes, schema previews, and upcoming breaking changes.

Changes on 07-20-21

Added the field duration to the query contentProgress.

Changes on 07-19-21

Added a new query to the graph: projectCatalog. This is currently in ALPHA.

Changes on 07-16-21

Added a new section for potential warnings in the response.

Warnings will be under an extensions object at the same level as errors and data in the response, i.e.:

{
  "data": {...},
  "extensions": {
    "warnings": [
      {
        "code": "DEPRECATION_WARNING",
        "message": "Field 'skillIqs' was deprecated on ...",
        "path": "skillIqs"
      }
    ]
  }
}

The following types of warning codes can be expected:

  • DEPRECATION_WARNING ( notice of usage of a field/query/mutation that is being used, but is being deprecated )
  • FIRST_ARG_LIMIT_EXCEEDED ( see BREAKING CHANGE section below)

BREAKING CHANGE

Moved and changed a custom error response when requesting more than a max page size on every query.

i.e. courseCatalog selecting 10,001 records via the first argument would truncate the results down to 10,000 and return an error along with the truncated data like the following:

query {
  courseCatalog(first:10001) {
    nodes {
      title
    }
  }
}

would produce the following response

{
  "errors": [
    {
      "message": "'first' parameter limit exceeded. Results over 10000 will be truncated.",
    }
  ],
  "data": {
    "courseCatalog": {
      "nodes": [...]
    }
  }
}

With these changes, the previous response will now look like:

{
  "data": {
    "courseCatalog": {
      "nodes": [...]
    }
  },
  "extensions": {
    "warnings": [
      {
        "code": "FIRST_ARG_LIMIT_EXCEEDED",
        "message": "Input argument 'first' limit exceeded. Results over 10000 will be truncated."
      }
    ]
  }
}

NOTE

Although data is still returned, keep in mind results will be truncated to the max page size per query when requesting more than the max.

Changes on 07-15-21

Added a new query to the graph: guideCatalog. This is currently in ALPHA.

Changes on 07-13-21

In query crAssessmentUserOptions

  • New field passFailSkipped added
  • passFail removed (bypassed normal deprecation flow b/c there were no consumers of this field)

Changes on 07-12-21

Updated the default privacyLevel from Private to Org in theeditChannel mutation

Added the following mutations:

  • addChannelGroups
  • deleteChannelGroup
  • updateChannelGroups
  • addChannelsToChannelGroups
  • deleteChannelGroupChannels

These mutations currently need the ALPHA release group to access.

Changes on 06-30-21

Support for nested teams in the team management APIs moved to GR:

  • addTeamManager
  • addTeam
  • editTeam
  • addTeamMember
  • removeTeamMember

Other endpoints moved to GR:

  • addTeamsToChannels
  • priority
  • planAdmins
  • planPermissionSets
    • admins is now deprecated
  • teamManagers
    • managers is now deprecated

Added completedOnStartDate and completedOnEndDate filters to contentProgress query to get records based on completedOn date.

Modified CrAssessmentUserCompletion query to use the new names for the fields below.

  • topicName => subjectName
  • topicAttemptCount => subjectAttemptCount

Added programId and programName fields to the CrAssessmentUserCompletion query

Modified CrAssessmentUserScore query to use the new names for the fields below.

  • completedTopicCount => numUserSuccessfulSubjectsPassed
  • availableTopicCount => numProgramAvailableSubjects
  • lastCompletedOn => lastSuccessfulSubjectPassedAt

Added programId and programName fields to the CrAssessmentUserScore query

Changes on 06-23-21

Moved channelGroup query from ALPHA -> BETA.

Changes on 06-22-21

Added a resendIfExists flag to the inviteManager mutation that determines whether a duplicate invite will be sent to a manager with existing unexpired invites for that team

Changes on 06-18-21

Added the ability to filter by a list of userId's to the following entities:

  • contentProgress
  • courseProgress
  • courseDailyUsage

Added the ability to filter by a list of contentId's to the contentProgress query

New filters need the ALPHA release group to access.

Changes on 06-09-21

Added an isOnAccount filter to the courseProgress and contentProgress queries to ALPHA. Use this filter to remove user progress records for users who currently do not have a license, but historically did have one.

Changes on 05-27-2021

Added inviteManager mutation which will invite a user to manage a team via email. Works even if they don't have an account

Changes on 05-17-2021

Updated skillAssessmentId in pathCatalog to the proper ID value, correctly allowing the linking of pathCatalog content to assessments

Changes on 05-12-2021

Moved Priorty query to BETA

Changes on 05-06-2021

Added the filter userIds to the following:

  • crAssessmentUserCompletions
  • crAssessmentUserOptions

*Note this filter has a maximum value of 100 userIds per query.

Changes on 04-29-2021

BREAKING CHANGES Breaking change (BETA): renamed managersV2 query to teamManagers

Changes on 04-27-2021

Added filters on the lastCompletedOn field for the crAssessmentUserScores using the following

  • earliestLastCompletedOn DateTime
  • latestLastCompletedOn DateTime

Changes on 04-26-2021

Added filters on the completedOn field for the crAssessmentUserCompletions using the following

  • earliestCompletedOn DateTime
  • latestCompletedOn DateTime

Changes on 04-19-2021

Modified Priority query to return Metric field data for ALPHA. Subfields of Metric:

  • projectId
  • usersAssessedCount
  • totalViewTime
  • userCount
  • usersWithRetakesCount
  • totalDuration
  • skillIqFirstQuintile
  • skillIqSecondQuintile
  • skillIqThirdQuintile
  • skillIqFourthQuintile
  • skillIqFifthQuintile
  • initialAverageSkillIq
  • retakeAverageSkillIq
  • initialToRetakeDelta
  • averageDaysToRetakeSkillIq
  • skillIqCount
  • courseCount
  • channelGroupCount
  • channelCount
  • label
  • lastUpdatedOn

Changes on 04-09-2021

Modified ChannelContent query to provide additional fields for Sections and ExternalLinks.

Here is an example query that pulls all of the available new fields.

Below are the more technical details for this change:

Updated ChannelContent query to use an Interface which allows for pulling out extra details for specific subfields with as part of the query. (View Examples page for usage).

Subfields:

  • ExternalLink
  • Section

Added the ChannelContentSection Interface.

Subfields:

  • ExternalLinkSection

Added externalLink and ExternalLinkSection types with the following specific fields:

  • url
  • title
  • contentType
  • level
  • durationInSeconds

Added section type with the following specific fields:

  • name as a string
  • description as a string
  • content as a ChannelContentSection

Deprecated the url field within section and ChannelContent in favor of using the new ExternalLink and ExternalLinkSection.

Changes on 04-05-2021

BREAKING CHANGES Breaking change: made actorUserId input argument required in addChannelMembers mutation.

Changes on 03-31-2021

Releasing nested team functionality to BETA. The following queries/mutations are affected by the change:

Queries:

  • planPermissionSets
  • user.teams

Mutations:

  • addTeamMember
  • removeTeamMember
  • addTeamManager.permissionSetId
  • addTeam.parentTeamId
  • editTeam.parentTeamId

Changes on 03-30-2021

Added assessmentIds filter to skillAssessmentResults query

Changes on 03-26-2021

Moved editTeam mutation from ALPHA to GR. Kept parentTeamId on editTeam as ALPHA.

Changes on 03-25-2021

Changed the following basic usage entites to be open to all plans with an api key:

Queries:

  • courseDailyUsage
  • courseProgress
  • contentProgress (currently in BETA)
  • teams
  • users/user
  • managers
  • admins
  • memberInvites

Mutations:

  • addTeam
  • addTeamManager
  • createUser
  • editUser
  • removeUser
  • deleteTeam
  • inviteMember
  • moveMemberToTeam
  • removeTeamManager
  • unassignMemberFromTeam
  • cancelInvite

Changes on 03-24-2021

Allows accessing SSO IDs for multiple plans when using a multiplan API Key in the crAssessmentUserCompletions query.

Changes on 03-19-2021

BREAKING CHANGES Breaking changes on the addChannelContent mutation:

  • Changed content input type to use enums instead of strings.
  • Changed the response to only return a success flag signaling whether or not the content was added to the channel.

Changes on 03-19-2021

Added the following to contentCatalog query:

  • Added isOnPlan field
  • Added showOffPlanContent filter

Changes on 03-05-2021

Changes to channels query:

  • Added processedOn field
  • Added isDeletedFromPlan field
  • Added includeDeletedRecords filter (defaults to false)
  • Added earliestProcessedOn filter
  • Added latestProcessedOn filter

Changes on 03-04-2021

  • Moved removeChannelContent and editChannel to GR
  • Added startedOn to crAssessmentUserOptions query.

Changes on 03-01-2021

Changes to crAssessmentUserOptions query:

  • Added completedOn field
  • Added earliestCompletedOn and latestCompletedOn filters

Changes on 02-26-2021

Added skillAssessmentId to pathCatalog query

Changes on 02-25-2021

Moved editChannel mutation from ALPHA to BETA

Changes on 02-18-2021

Added currentSsoIdentifier, createdOn and note fields to the following queries:

  • planAdmins
  • managersV2

Also moved planAdmins and managersV2 queries from ALPHA to BETA

Changes on 02-12-2021

Updated query crAssessmentUserOptions to add the following fields:

  • createdOn
  • lastUserInteractionOn
  • passFail

updatedOn is now backed by a new internal field that gets updated when any change to the record. Previously it was backed by lastUserInteractionOn, which we are now exposing separately.

Also removed the user field.

Changes on 02-04-2021

Added the channelGroup query in ALPHA Added the priority query in ALPHA Move archiveChannel mutation from BETA to GR Added skillId field to skillIqsSummary query

Changes on 01-29-2021

Updated query crAssessmentUserScores to add the following fields:

  • createdOn
  • lastCompletedOn

Updated query crAssessmentUserCompletions with the following changes:

  • createdOn, updatedOn and currentSsoIdentifier fields added
  • startDate and endDate filters operate on the new updatedOn field (previously operated on the startedOn field)
  • Added filters for completeOrIncomplete and passFailSkipped

Changes on 01-13-2021

Updated the query pathCatalog to include levels.

Changes on 01-11-2021

Added the addTeamsToChannels mutation in ALPHA

Changes on 01-04-2021

Added the query pathCatalog in ALPHA.

Made the following changes to the inviteMember mutation:

  • Added the field teamIds and deprecated the field teamId on both the input and the payload types.
  • Added the field planUserId and deprecated the field inviteId on the payload type.

Changes on 12-22-2020

Added courseIds filter to courseProgress and courseDailyUsage queries.

Changes on 12-01-2020

Added the field note to the input and payload types for the editUser mutation.

Changes on 11-23-2020

  • Added an ownerIds filter to the channels query.
  • Added an isComplete filter to the contentProgress query.

Added the following mutations in BETA:

  • archiveChannel
  • removeChannelContent

Changes on 11-19-2020

Added the following mutations in ALPHA:

  • addTeamMember
  • removeTeamMember

Changes on 11-17-2020

Added the planPermissionSets query in ALPHA.

Changes on 11-16-2020

Added the field permissionSetId in ALPHA to the input type for the addTeamManager mutation.

Changes on 11-13-2020

Added the field parentTeamId in ALPHA to the input and payload types for the addTeam mutation.

Changes on 11-12-2020

Added memberInvitesV2 query in ALPHA. Changes (relative to the memberInvites query) include:

  • The inviteId field has been replaced with planUserId.
  • teamId is no longer available
  • isCanceled is now available

Changes on 11-11-2020

Added managersV2 query in ALPHA. Changes (relative to the managers query) include:

  • The id field has been replaced with planUserId.
  • The query returns one record for each manager, and returns a list of all teams they manage (instead of returning a record for each manager-team instance).

Changes on 11-06-2020

Added Tags entity with the following fields:

  • contentId
  • idNum
  • superDomain
  • domain
  • audience
  • primaryAtomic: which includes name and alternativeNames

Note: the above fields are currently in BETA (with the exception of contentId and idNum).

Also included within Tags is the following deprecated fields:

  • tools
  • topics
  • audiences
  • certifications
  • primaryAtomicTags

Changes on 11-03-2020

Added planAdmins query in ALPHA. Changes (relative to the admins query) include:

  • The id field has been removed.

Changes on 10-29-2020

Added the following fields to contentCatalog:

  • imageUrl
  • duration

Changes on 10-27-2020

The following queries have been added in BETA:

  • crAssessmentFormLevelStatistics
  • crAssessmentItemLevelStatistics
  • crAssessmentOptionLevelStatistics

Changes on 10-26-2020

The following fields on the crAssessmentUserCompletions BETA query have changed names:

  • tqTopic is now topicName
  • testFormId is now formTaxonomy

A filter with startDate and endDate has been added to the crAssessmentUserCompletions BETA query.

Changes on 10-23-2020

The query crAssessmentUserOptions has been added in BETA.

Changes on 10-22-2020

The following BETA queries have changed names:

  • criterionAssessmentUserCompletions is now crAssessmentUserCompletions
  • criterionAssessmentUserScores is now crAssessmentUserScores

Changes on 10-20-2020

The field ssoIdentifiers on the User type has been deprecated. Use currentSsoIdentifier instead.

Changes on 10-13-20

The query criterionAssessmentUserCompletions has been added in BETA.

Changes on 10-09-20

The query criterionAssessmentUserScores has been added in BETA.

Changes on 10-05-2020

Deprecated the following fields within Tags in courseCatalog:

  • tools
  • topics
  • audiences
  • primaryAtomicTags
  • certifications

Note: Please see update on 08-28-2020 on new tag fields which are currently in BETA.

Changes on 09-10-2020

Released contentProgress query to BETA.

Changes on 09-09-2020

  • Replaced the type field on ContentCatalogFilter with contentTypes, which now takes a list of ContentCatalogType.
  • Changed ContentCatalogType values to be capitalized.

Changes on 09-04-2020

Updated contentCatalog to return only published content by default.

  • Replaced status filter value with showRetiredContent

Changes on 08-28-2020

Added the following fields within Tags to the entity course:

  • audience
  • domain
  • primaryAtomic
  • superDomain

Note these fields are currently in BETA.

Changes on 08-20-2020

Added isCourseCompleted to CourseProgressFilter for the entity CourseProgress.

Changes on 08-19-2020

The field ssoIdentifiers within UserFilter has been changed to do an exact search on the field currentSsoIdentifier.

  • It's prior behavior, to perform a fuzzy search on the field ssoIdentifiers.
  • You can still provide an array of ssoIdentifiers and will check for each.

The field updatedOn has bee added to the following entities:

  • CourseDailyUsage
  • CourseProgress

Changes on 08-14-2020

Added a new query to the graph: contentCatalog. This is currently in BETA.

Added Functionality

The addChannelContent mutation now supports guides and skill assessments.

Schema Changes on 08-05-2020

The following mutations have been added:

  • editUser

Schema Changes on 08-04-2020

The following fields have been added to the addChannelMembers mutation input:

  • ownerUserId

The following mutations have been added to GR:

  • addRole
  • editRole

Schema Changes on 07-30-2020

The SkillAssessmentCatalog now has Topics and Subtopics.

Schema Changes on 07-22-2020

The input fields startDate and endDate have been added to the following input types:

  • CourseDailyUsageFilter
  • CourseProgressFilter
  • RoleIqLearnerLevelFilter
  • SkillAssessmentResultFilter

The input fields afterDate and beforeDate have been removed from the following input types:

  • RoleIqLearnerLevelFilter

The input fields afterDate and beforeDate have been deprecated on the following input types:

  • CourseDailyUsageFilter
  • CourseProgressFilter
  • SkillAssessmentResultFilter

Schema Changes on 07-21-2020

  • The mutations assignUsersToRole and assignTeamsToRole have been added to GR.

API General Release on 07-15-2020

Pluralsight's graphQL API is now in General Release. All API keys are automatically approved and tagged as GR.

Schema Changes on 07-15-2020

  • The mutation cancelInvite has been added.
  • The field lastLogin has been added to the User type.

Schema Changes on 07-14-2020

  • The query team has been added.
  • The field retakeReasons on the SkillAssessmentResult type has been deprecated.

Schema Changes on 07-13-2020

The mutation addRole has been added in alpha.

Schema Changes on 06-26-2020

Within AddChannelMembersInput we are checking to see if the field instructions is less than or equal to the 500 character limit.

Within AddChannelInput we are checking the following field lengths:

  • description <= 500 characters.
  • name <= 100 characters.
  • objective <= 100 characters.

Schema Changes on 06-23-2020

In SkillAssesmentResut the following fields have been deprecated:

  • approximateLevel Use quintileLevel instead.
  • status This field is being discontinued.

Added the nullable fields actorUserId and skipNotificationsEmail to AddChannelMembersInput and AddChannelMembersPayload within the AddChannelMembers mutation. Note the field actorUserId will be required at a future point.

Schema Changes on 06-19-2020

The fields createdOn and updatedOn within roleIqCatalog have been changed from Date to DateTime.

Schema Changes on 06-18-2020

Added the nullable field instructions to type AddChannelMembersInput and AddChannelMembersPayload.

The following queries have been added to the graph:

  • skillAssessmentResult
  • skillAssessmentResults

The following queries have been deprecated:

  • skillIqs
  • sillIq

Please use skillAssessment and skillAssessments

Schema Changes on 06-17-2020

The following queries have been added to the graph:

  • skillAssessmentCatalog added

The type Query skillCatalog deprecated. Please use skillAssessmentCatalog.

Schema Changes on 06-16-2020

The following fields have been added to the courseCatalog:

  • averageRating
  • numberOfRatings

The field skillShortName on the skillIqs and skillIq has been deprecated.

The following fields on skillCatalog have been added:

  • description

Schema Changes on 06-09-2020

The field groupId on the Team type is now deprecated.

Schema Changes on 06-08-2020

The mutation removeUser was added.

Schema Changes on 06-01-2020

The following fields have been added to the UserFilter input type:

  • isCurrent
  • notes
  • ssoIdentifiers
  • emails

The following field has been deprecated on the UserFilter input type:

  • onlyCurrent

Schema Changes on 05-26-2020

The mutation removeChannelMember has been added.

Schema Changes on 05-21-2020

The mutation addChannelMember has changed to addChannelMembers and now has two additional fields: memberUserIds and contributorUserIds. It no longer supports receiving a single userId.

Schema Changes on 05-13-2020

The following query has been added to the graph:

  • memberInvites

The following mutations has been added to the graph:

  • createUser
  • inviteMember

Schema Changes on 05-08-2020

The following query has been added to the graph:

  • roleIqsSummary

Schema Changes on 05-05-2020

The following queries have been added to the graph:

  • skillIqsSummary

The following fields have been added to the channels and channel queries:

  • memberCount
  • durationInSeconds, durationInHours
  • averageCompletion
  • owner
  • lastActivity

Release stage changed on 04-22-2020

  • The GraphQL API is now officialy in BETA.

Schema Changes on 04-15-2020

The following changes have been made to the schema:

  • Added pagination to skillCatalog query
  • Added pagination to channelMembers query
  • Added pagination to channelContent query

Schema Changes on 04-14-2020

The following changes have been made to the schema:

  • Added pagination to roleIqSkills query

Schema Changes on 04-13-2020

The following changes have been made to the schema:

  • Added pagination to roleIqAssignment query

Schema Changes on 03-26-2020

The field course was added to the following types:

  • CourseProgress
  • CourseDailyUsage

Schema Changes on 03-25-2020

The field user was added to the following types:

  • CourseProgress
  • CourseDailyUsage

Schema Changes on 03-02-2020

The following changes have been made to the schema:

  • The roleIqCatalog query now has an optional RoleIqCatalogFilter input, which allows filtering by name.

Schema Changes on 02-07-2020

The following changes have been made to the schema:

  • The roleIqLearnerLevels query has been added.

Schema Changes on 01-24-2020

The following changes have been made to the schema:

  • On the skillIqs query, the afterDate and beforeDate parameters were replaced with a filter input object, which contains afterDate and beforeDate.

Schema Change on 01-21-2020

The following changes have been made to the schema:

  • InteractiveCourse.ratingAverage changed type from Int to Float

Schema Change on 01-20-2020

The following changes have been made to the schema:

  • Course.releasedDate and Course.displayDate changed type from Date to DateTime

Schema Change on 01-17-2020

The following changes have been made to the schema:

  • The interactiveCourseCatalog query has been added