Skip to main content

awardtypes

Each row represents an award type, a configurable category of recognition (such as a badge or credit type) used to label and group individual awards. Award types include display settings like label, plural label, icon, and whether to show on the learner dashboard or not.

Full schema​

View all columns and table relationships

Status group​

This table does not currently include a statusgroup column. It will be added in the future.

Column details​

For columns that appear across many tables (id, companyid, createdat, updatedat, etc.), see Common Columns. The columns below are specific to award types.

label: singular display label shown in the LMS for awards of this type. Configured by the company in the Award Types setup screen. Examples: Point, CEU, Credit.

plurallabel: plural form of the label, used wherever an award count is displayed. Examples: Points, CEUs, Credits.

icon: identifier of the icon displayed next to this award type in the learner dashboard's Badges & Leaderboard widget. Only applies when includeondashboard = true. Selected from the platform's fixed list of available icons in the Award Types setup screen; null when no icon has been chosen.

shortid: a short identifier for the award type within the company's award-types configuration. It stays the same even if the label or icon are later updated. This is the column used to join back to the awards table: awards.awardtypeid = awardtypes.shortid.

includeondashboard​

Controls whether this award type is surfaced to learners in the Badges & Leaderboard widget on the learner dashboard (the learner-facing home page in your site, configured via Site Builder > Layouts > Dashboard Layout).

  • When true, learners see their earned and earnable badges for this award type in that widget.
  • When false, the award type is still tracked, granted, and visible to admins, but is hidden from the learner dashboard widget.

This is not related to Reporting Hub or the manager experience. See Setting Up Gamification for the full learner-facing behavior.

Sample query​

select
  t.id,
  t.shortid,
  t.includeondashboard,
  t.icon,
  t.label,
  t.plurallabel
from awardtypes as t
limit 100

Joining awards to award types​

Award records reference an award type via awards.awardtypeid, which matches awardtypes.shortid:

select
  a.id,
  a.userid,
  a.clientid,
  a.awardwhen,
  a.awardamount,
  awt.label,
  awt.plurallabel,
  awt.icon,
  awt.includeondashboard
from awards as a
  left join awardtypes as awt on awt.shortid = a.awardtypeid
limit 100

Award counts and totals grouped by award type:

select
  awt.label,
  count(*) as award_count,
  sum(a.awardamount) as award_amount
from awards as a
  left join awardtypes as awt on awt.shortid = a.awardtypeid
group by awt.label