OBJECT

Guide

Main type that represents Guide catalog data.

link GraphQL Schema definition

  • type Guide {
  • # The id of the guide.
  • id: ID!
  • # The status of the guide. Possible values are: published, retired.
  • status: GuideStatus!
  • # The pathName for the guide.
  • pathName: String!
  • # The title for the guide.
  • title: String!
  • # The Search Engine Optimized meta title for the guide. Can be an empty string.
  • metaTitle: String!
  • # The Search Engine Optimized meta description for the guide. This can be an empty
  • # string
  • metaDescription: String!
  • # The UTC time stamp for when the guide was last modified.
  • latestModifiedOn: DateTime!
  • # The UTC time stamp for when the first draft of the guide was created.
  • createdOn: DateTime!
  • # The UTC time stamp for the first time the guide was published. This can be null.
  • datePublished: DateTime
  • # The UTC time stamp for the latest time the guide was published (will be
  • # different from datePublished if the guide was republished). This can be null.
  • dateModified: DateTime
  • # The id of the author who wrote the guide. This can be null.
  • authorId: String
  • # The first and last name of the author of the guide.
  • authorFullName: String!
  • # The url for the author's profile picture.
  • authorAvatarUrl: String!
  • # The user ids of the people authorized to edit guides.
  • assignedUserIds: [String]!
  • # The link to the guide in the content tools.
  • guideEditLink: String!
  • # The contents of the guide in markdown. This can be an empty string.
  • content: String!
  • # The estimated time it will take to read the guide in minutes.
  • duration: Int!
  • # The ids from curriculum objectives. This can be an empty array.
  • curriculumObjectiveIds: [String]!
  • # The URL where the content lives. All canonicalUrls will be on www unless they
  • # are 'gated' (read: Only signed in users can view this), in which case it will be
  • # on app. Further, if a guide is not published, the canonicalUrl will be NULL.
  • canonicalUrl: String
  • # True if this content is available to one of the plans associated with they API
  • # key being used.
  • isOnPlan: Boolean!
  • }