Overview
The Code Detail Report (Publishers) provides transaction-level details for all eBook and Courseware Bookshelf code activity. Use this dashboard to track the lifecycle of codes — from creation through redemption or cancellation — across your distributed titles. It is designed to support operational monitoring and reconciliation of code-based access distribution.
Audience | Publishers / Internal VST Users |
|---|---|
Internal vs. External | External — the dashboard is filtered to show data only for the company associated with the logged-in system user |
Number of Tabs | 1 |
Contains PII | Yes |
Last Documentation Update | 2026-05-29 |
Key Questions This Dashboard Answers
Use this section to help end users quickly determine if this dashboard meets their needs.
How many codes have been created, redeemed, or cancelled within a given date range?
Which titles or products are codes being generated against, and in what quantities?
What is the distribution of codes by distributor, and what is the current status of those codes?
Which codes were created in a date range but have not yet been redeemed?
How to Use This Dashboard
Guidance for navigating and getting value from this dashboard.
Set your filters first — Begin by selecting your Filter Criteria to define whether you want to view codes based on their Created date, Redeemed date, or a combination. Then set your Date Range accordingly. These two filters are required before results will populate.
Read the tiles — Summary KPI tiles at the top display aggregate counts of codes created, redeemed, and cancelled. The visual tiles below break down code activity by distributor and product. The data table at the bottom provides a row-level export of all matching code records.
Drill down for detail — Use the data table to review individual code records. You can download the table for offline analysis or reconciliation.
💡 Tip: Start with the KPI tiles to get an aggregate view of your code activity, then use the charts and table below to investigate specific products or distributors.
Filters
Filters apply across the entire dashboard unless otherwise noted.
Filter Name | Description | Required? | Default Value | Applies To |
|---|---|---|---|---|
Filter Criteria | Defines the scope for viewing code details — choose whether to filter by Code Created date, Code Redeemed date, or a combination (OR / AND logic). | Yes | Code Created (Date) OR Code Redeemed (Date) | All tabs |
Date Range | Date range applied to the selected Filter Criteria. Supports relative dates (e.g., "last month") and specific date ranges. | Yes | None | All tabs |
Code Status | Filters results to codes in a specific state: Created, Redeemed, or Cancelled. | No | All | All tabs |
SKU | Filters to a specific item SKU. Supports multi-value paste (comma-separated or column copy from Excel, up to 16,000 values). Note: semi-colon separation does not work. | No | All | All tabs |
Item Name | Filters by the name of the product the Bookshelf code was generated against. | No | All | All tabs |
Product Type | Filters by the product format (e.g., Demo, Package, Rental, Single). | No | All | All tabs |
Code Distribution Reason | Filters by the intended use for the Bookshelf code. | No | All | All tabs |
Code Distributor | Filters by the name of the company that distributed the code. | No | All | All tabs |
Distributor Country | Filters by the 2-character country code for the distributor's location. | No | All | All tabs |
Code Creator | Filters by the application or system user that generated the code. | No | All | All tabs |
Publisher | Filters by the publisher name associated with the distributed asset. | No | All | All tabs |
Code Tags | Filters by the tag value associated with the code. Applies to the data table only — does not filter the chart visualizations. | No | All | Data table |
Dashboard Tiles
Tiles are numbered top to bottom, left to right.
Tile Name | Tab | Visualization Type | Description |
|---|---|---|---|
Codes by Distributor | Main | Bar Chart | Displays a breakdown of all codes by distributor within the selected filter criteria and date range. |
Codes by Publisher | Main | Bar Chart | Displays a breakdown of all codes by publisher within the selected filter criteria and date range. |
Total Codes Created | Main | KPI | Count of all codes created within the selected date range. |
Total Codes Redeemed | Main | KPI | Count of all codes redeemed within the selected date range. |
Total Codes Cancelled | Main | KPI | Count of all codes cancelled within the selected date range. |
Codes by Product | Main | Bar Chart | Displays a breakdown of all codes by product within the selected filter criteria and date range. |
Codes by Current Status and Category Created (in Selected Date Range) | Main | Table / Chart | Displays codes grouped by category and status (created, redeemed, or cancelled) for codes created within the selected date range. |
Clickable Tiles: The data table supports row-level download for offline review and reconciliation.
Fields & Metrics
All fields used across this dashboard, listed alphabetically.
Field Name | Description | Data Type | Example Value | Contains PII? |
|---|---|---|---|---|
Access Code | Publisher's access code required to access the asset (Courseware only). Only populated when Asset Type is "Online Resource" or "Online Resource Bundle". | Text | ABC123 | No |
Access Code Revealed | Indicates whether the publisher's access code has been revealed to the end user. Populated with "Yes" when revealed; otherwise null. | Text | Yes | No |
Asset Redistributor | Name of the company that distributed the asset, when different from the publisher. | Text | — | No |
Asset Type | Indicates the asset type accessed using the Bookshelf code. Note: "Subscription" indicates access through an Explore subscription, not a discrete asset type. | Text | Single | No |
Bookshelf Code | The code generated and delivered to provide access to the asset. | Text | XXXX-XXXX-XXXX | No |
Cancelled (Date) | Date the code was cancelled. | Date | 2024-09-01 | No |
Code Distribution Reason | Intended use for the Bookshelf code. | Text | Review Copy | No |
Code Distributor | Name of the company that distributed the code. | Text | — | No |
Code Price | Code-level price set at the time the Bookshelf code is created, where applicable. | Number | 29.99 | No |
Code Status | Current state of the Bookshelf code: Created (generated, not yet redeemed), Redeemed (redeemed by an end user), or Cancelled (created and subsequently cancelled). | Text | Created | No |
Code Tags | Used to support additional data mapping when needed. | Text | — | No |
Created (Date) | Date the code was created. | Date | 2024-08-15 | No |
Distributor Country | 2-character country code for the country where the distributor is located. | Text | US | No |
Expiration (Date) | Date the code expires, if a discrete expiration date exists. | Date | 2025-12-31 | No |
Item Name | Name of the product the Bookshelf code was generated against. | Text | — | No |
Library Name | Name of the library used to categorize assets based on a taxonomy, where applicable. | Text | — | No |
License Duration (Download) | Duration of access to the downloadable version of the material in Bookshelf. | Text | 180 days | No |
License Duration (Online) | Duration of access to the online version of the material in Bookshelf. | Text | 365 days | No |
Product Type | Indicates the product format: Demo (sample/demo product), Package (bundled product), Rental (subscription/rental product), Single (perpetual product). | Text | Single | No |
Publisher | Name of the publisher associated with the distributed asset. | Text | — | No |
Redeemed (Date) | Date the code was redeemed by an end user. | Date | 2024-09-05 | No |
Refund Expiration (Date) | Date after which the code is no longer eligible for refunds. | Date | 2024-09-19 | No |
Related Digital ISBN | Related digital ISBN of the SKU the code was generated against. | Text | — | No |
Related Print ISBN | Related print ISBN of the SKU the code was generated against. | Text | — | No |
SKU | Item SKU the Bookshelf code was generated against. | Text | — | No |
Frequently Asked Questions
Q: Why am I only seeing data for my own company?
A: This dashboard is filtered automatically to show data associated with your Manage system user. Publishers see only their own codes and titles.
Q: What is the difference between "Code Created (Date) OR Code Redeemed (Date)" and "Code Created (Date) AND Code Redeemed (Date)"?
A: The OR option returns all codes where the created or redeemed date falls within the range — this is the broadest view. The AND option returns only codes where both the created and redeemed dates fall within the same range.
Q: Can I search for multiple SKUs at once?
A: Yes. Paste a comma-separated list or copy a column of values from a spreadsheet directly into the SKU filter. The filter supports up to 16,000 values. Note: semi-colon-separated values are not supported.
Q: What does "Subscription" mean in the Asset Type field?
A: "Subscription" indicates the asset is accessed through an Explore subscription, not a specific asset type. It is a system classification and does not reflect a distinct format.