Skip to main content

Certificate

For loop type learndash_certificate, here are the query parameters and fields.

Query parameters​

  • course - Course ID(s) or "current" for current course
    Type: string, array

  • earned - Earned certificate, "true"/"false"
    Type: bool

  • quiz - Quiz ID(s) or "current" for current quiz
    Type: string, array

  • user - User ID or "current" for current user
    Type: string

Fields​

  • certificate_aggregate_percentage - Displays the total percentage score for all quizzes taken as part of the course - works for course certificates only.

  • certificate_aggregate_points - Displays the total points earned for the course - works for course certificates only.

  • certificate_aggregate_score - Displays the final score received for the course - works for course certificates only.

  • certificate_aggregate_timespent - Displays the total time spent on quizzes for the course as a whole - works for course certificates only.

  • certificate_aggregate_total_points - Displays the total points earned for the course - works for course certificates only.

  • certificate_assigned_to - Certificate assigned to "group/course/quiz"

  • certificate_completed_on - Displays the date the course was completed - works for course certificates only.

  • certificate_course_cert_url - Course certificate url for specified/current user

  • certificate_course_id - Certificate course ID - works for course certificates only.

  • certificate_course_points - Displays the total available points for the course - works for course certificates only.

  • certificate_course_price - Displays the course price (only for one-time payment courses) - works for course certificates only.

  • certificate_course_price_type - Displays the Access Mode for the given course - works for course certificates only.

  • certificate_course_title - Displays the course title - works for course certificates only.

  • certificate_course_url - Displays the course URL - works for course certificates only.

  • certificate_cumulative_percentage - Displays the average percentage of all quizzes taken in the course - works for course certificates only.

  • certificate_cumulative_points - Displays the average points earned - works for course certificates only.

  • certificate_cumulative_score - Displays the average score for all graded parts of the course - works for course certificates only.

  • certificate_cumulative_timespent - Displays the average time spent on each part of the course - works for course certificates only.

  • certificate_cumulative_total_points - Displays the average points earned - works for course certificates only.

  • certificate_earned_date - Certificate earned date

  • certificate_earned_timestamp - Certificate earned timestamp

  • certificate_enrolled_on - Displays the course enrollment date (this does not apply to OPEN courses) - works for course certificates only.

  • certificate_group_cert_url - Group certificate url for specified/current user

  • certificate_group_completed_on - Displays the date the user completed all courses assigned to the group - works for group certificates only

  • certificate_group_courses_count - Displays the number of courses in the group - works for group certificates only

  • certificate_group_enrolled_on - Displays the date the user enrolled into the group - works for group certificates only

  • certificate_group_id - Certificate group ID - works for group certificates only.

  • certificate_group_percent_completed - Displays the score achieved in the group\’s courses - works for group certificates only

  • certificate_group_price - Displays the group's price - works for group certificates only

  • certificate_group_price_type - Displays the group's Access Mode - works for group certificates only

  • certificate_group_title - Displays the group's title - works for group certificates only

  • certificate_group_url - Displays the group's URL - works for group certificates only

  • certificate_group_user_group_status - Displays the group progress status of the user - works for group certificates only

  • certificate_id - Certificate category ID

  • certificate_quiz_cert_url - Quiz certificate url for specified/current user

  • certificate_quiz_count - Displays the number of questions within the quiz - works for quiz certificates only.

  • certificate_quiz_course_id - Displays course id that quiz - works for quiz certificates only.

  • certificate_quiz_course_title - Displays the name of the course that the quiz is associated with - works for quiz certificates only.

  • certificate_quiz_id - Certificate quiz ID - works for quiz certificates only.

  • certificate_quiz_lesson_id - Displays lesson id that quiz - works for quiz certificates only.

  • certificate_quiz_pass - Displays the score required in order to pass the quiz - works for quiz certificates only.

  • certificate_quiz_percentage - Displays the percentage grade received by the user on the quiz - works for quiz certificates only.

  • certificate_quiz_points - Displays the points received by the user on the quiz - works for quiz certificates only.

  • certificate_quiz_pro_quizid - Displays quiz pro id that quiz - works for quiz certificates only.

  • certificate_quiz_score - Displays the score received for that quiz - works for quiz certificates only.

  • certificate_quiz_timespent - Displays the time spent taking the quiz - works for quiz certificates only.

  • certificate_quiz_timestamp - Displays the day/time when the quiz was completed - works for quiz certificates only.

  • certificate_quiz_title - Displays the name of the quiz - works for quiz certificates only.

  • certificate_quiz_topic_id - Displays topic id that quiz - works for quiz certificates only.

  • certificate_quiz_total_points - Displays the total possible points that can be received for a given attempt - works for quiz certificates only.

  • certificate_status - Certificate status, "earned/not-earned"

  • certificate_user_course_points - Displays the amount of points the user earned for the course - works for course certificates only.

  • certificate_user_course_time - Displays the total time spent on a course - works for course certificates only.

  • certificate_user_description - Displays a user's bio

  • certificate_user_display_name - Displays a user's full display name.

  • certificate_user_email - Displays a user's email address

  • certificate_user_first_name - Displays a user's first name

  • certificate_user_id - User ID

  • certificate_user_last_name - Displays a user's last name

  • certificate_user_login - Displays a user's username

  • certificate_user_url - Displays a user's website address