4.0 COUNTER reports
Platform Reports provide a summary of activity on a given platform to support the evaluation of platforms and to provide high-level statistical data to support surveys and reporting to funders.
Table 4 (below): Platform Master Report and Standard Views
| Report_ID |
Report_Name |
Details |
Host_Types |
| PR |
Platform Master Report |
A customizable report summarizing activity across a content provider’s platforms that allows the user to apply filters and select other configuration options. |
All Host_Types:
A&I_Database
Aggregated_Full_Content
Data_Repository*
Discovery_Service
eBook
eBook_Collection
eJournal
Full_Content_Database
Multimedia
Multimedia_Collection
Repository
Scholarly_Collaboration_Network |
| PR_P1 |
Platform Usage |
Platform-level usage summarized by Metric_Type. |
All Host_Types:
A&I_Database
Aggregated_Full_Content
Data_Repository*
Discovery_Service
eBook
eBook_Collection
eJournal
Full_Content_Database
Multimedia
Multimedia_Collection
Repository
Scholarly_Collaboration_Network |
*Data repositories may choose to conform to the Code of Practice Release 5 or, alternatively, may wish to work with the Code of Practice for Research Data.
4.1.1 Report Header
The table below shows the header details for the Platform Master Report and its Standard Views. For the tabular reports, elements MUST appear in the exact order shown, and spelling, casing, and punctuation of labels (Column A) and fixed data elements such as report names (Column B) MUST match exactly. The JSON version of the report MUST comply with the Report_Header definition in the COUNTER_SUSHI API Specification (see Section 8 below). Entries in the table appearing in italics describe the values to include.
Table 4.a (below): Header for Platform Master Report and Standard Views
| Row in Tabular Report |
Label for Tabular Report (Column A) |
Value for Tabular Report (Column B) |
| PR |
PR_P1 |
| 1 |
Report_Name |
Platform Master Report |
Platform Usage |
| 2 |
Report_ID |
PR |
PR_P1 |
| 3 |
Release |
5 |
5 |
| 4 |
Institution_Name |
Name of the institution the usage is attributed to. |
| 5 |
Institution_ID |
Identifier(s) for the institution in the format of {namespace}:{value}. Leave blank if identifier is not known. Multiple identifiers may be included by separating with semicolon-space (“; ”). |
| 6 |
Metric_Types |
Semicolon-space delimited list of Metric_Types included in the report. |
Searches_Platform; Total_Item_Requests; Unique_Item_Requests; Unique_Title_Requests |
| 7 |
Report_Filters |
Semicolon-space delimited list of filters applied to the data to generate the report. |
Access_Method=Regular* |
| 8 |
Report_Attributes |
Semicolon-space delimited list of report attributes applied to the data to generate the report. |
(blank) |
| 9 |
Exceptions |
Any exceptions that occurred in generating the report, in the format “{Exception Number}: {Exception Description} ({Data})” with multiple exceptions separated by semicolon-space (“; ”). |
| 10 |
Reporting_Period |
Date range requested for the report in the form of “Begin_Date=yyyy-mm-dd; End_Date=yyyy-mm-dd”. The “dd” of the Begin_Date is 01. The “dd” of the End_Date is the last day of the month. |
| 11 |
Created |
Date and time the report was run in RFC3339 date-time format (yyyy-mm-ddThh:mm:ssZ). |
| 12 |
Created_By |
Name of organization or system that generated the report. |
| 13 |
(blank) |
(blank) |
(blank) |
*If a Platform filter is used (see Section 3.3.8 for details), it MUST be included in Report_Filters.
4.1.2 Column Headings/Elements
The following elements MUST appear in the tabular report in the order they appear in the table below. For guidance on how these fields appear in the JSON format, refer to the COUNTER_SUSHI API Specification (see Section 8 below). Mandatory (M) elements MUST be included in the report. Optional (O) elements MUST only be included if requested, and if included they MUST be listed in Attributes_To_Show in the Report_Attributes header.
Table 4.b (Below): Column Headings/Elements for Platform Master Report and Standard Views
| Field Name (Tabular) |
PR |
PR_P1 |
| Platform |
M |
M |
| Data_Type |
O |
|
| Access_Method |
O |
|
| Metric_Type |
M |
M |
| Reporting_Period_Total |
M |
M |
| Mmm-yyyy |
M* |
M |
*unless Exclude_Monthly_Details=True is used
4.1.3. Filters and Attributes
The following table presents the values that can be chosen for the Platform Master Report and that are pre-set for the Standard Views. If a filter is not included in the request, the default applies. For the Standard Views an empty cell indicates that the filter is not applied.
Table 4.c (below) Filters/Attributes for Platform Master Report and Standard Views
| Filter/Attribute |
Filters available (options for Master Report and required for Standard Views) |
| PR |
PR_P1 |
| Data_Type |
One or more or all (default) of the Data_Types applicable to the platform. |
|
| Access_Method |
One or all (default) of:
– Regular
– TDM |
Regular |
| Metric_Type |
One or more or all (default) of:
– Searches_Platform
– Total_Item_Investigations
– Total_Item_Requests
– Unique_Item_Investigations
– Unique_Item_Requests
– Unique_Title_Investigations
– Unique_Title_Requests |
Searches_Platform
Total_Item_Requests
Unique_Item_Requests
Unique_Title_Requests |
| Exclude_Monthly_Details |
False (default) or True |
|
If a filter is applied to a column that doesn’t show on the report, usage for all selected attribute values is summed and the totals are presented in the report.
4.2 Database Reports
Database Reports provide a summary of activity related to a given database or fixed collection of content that is packaged like a database. These reports provide a means of evaluating the impact a database has for an institution’s users.
Table 4.d (below): Database Master Report and Standard Views
| Report_ID |
Report_Name |
Details |
Host_Types |
| DR |
Database Master Report |
A customizable report detailing activity by database that allows the user to apply filters and select other configuration options. |
A&I_Database
Aggregated_Full_Content
Discovery_Service
eBook_Collection
Full_Content_Database
Multimedia_Collection |
| DR_D1 |
Database Search and Item Usage |
Reports on key Searches, Investigations and Requests metrics needed to evaluate a database. |
A&I_Database
Aggregated_Full_Content
Discovery_Service
eBook_Collection
Full_Content_Database
Multimedia_Collection |
| DR_D2 |
Database Access Denied |
Reports on Access Denied activity for databases where users were denied access because simultaneous-use licenses were exceeded or their institution did not have a license for the database. |
A&I_Database
Aggregated_Full_Content
Discovery_Service
eBook_Collection
Full_Content_Database
Multimedia_Collection |
4.2.1 Report Header
The table below shows the header details for the Database Master Report and its Standard Views. For the tabular reports, elements MUST appear in the exact order shown, and spelling, casing, and punctuation of labels (Column A) and fixed data elements such as report names (Column B) MUST match exactly. The JSON version of the report MUST comply with the Report_Header definition in the COUNTER_SUSHI API Specification (see Section 8 below). Entries in the table appearing in italics describe the values to include.
Table 4.e (below): Header for Database Master Report and Standard Views
| Row in Tabular Report |
Label for Tabular Report (Column A) |
Value for Tabular Report (Column B) |
| DR |
DR_D1 |
DR_D2 |
| 1 |
Report_Name |
Database Master Report |
Database Search and Item Usage |
Database Access Denied |
| 2 |
Report_ID |
DR |
DR_D1 |
DR_D2 |
| 3 |
Release |
5 |
5 |
5 |
| 4 |
Institution_Name |
Name of the institution the usage is attributed to. |
| 5 |
Institution_ID |
Identifier(s) for the institution in the format of {namespace}:{value}. Leave blank if identifier is not known. Multiple identifiers may be included by separating with semicolon-space (“; ”). |
| 6 |
Metric_Types |
Semicolon-space delimited list of Metric_Types included in the report. |
Searches_Automated; Searches_Federated; Searches_Regular; Total_Item_Investigations; Total_Item_Requests |
Limit_Exceeded; No_License |
| 7 |
Report_Filters |
Semicolon-space delimited list of filters applied to the data to generate the report. |
Access_Method=Regular* |
Access_Method=Regular* |
| 8 |
Report_Attributes |
Semicolon-space delimited list of report attributes applied to the data to generate the report. |
(blank) |
(blank) |
| 9 |
Exceptions |
Any exceptions that occurred in generating the report, in the format “{Exception Number}: {Exception Description} ({Data})” with multiple exceptions separated by semicolon-space (“; ”). |
| 10 |
Reporting_Period |
Date range requested for the report in the form of “Begin_Date=yyyy-mm-dd; End_Date=yyyy-mm-dd”. The “dd” of the Begin_Date is 01. The “dd” of the End_Date is the last day of the month. |
| 11 |
Created |
Date and time the report was run in RFC3339 date-time format (yyyy-mm-ddThh:mm:ssZ). |
| 12 |
Created_By |
Name of organization or system that generated the report. |
| 13 |
(blank) |
(blank) |
(blank) |
(blank) |
*If a Platform filter is used (see Section 3.3.8 for details), it MUST be included in Report_Filters.
4.2.2 Column Headings/Elements
The following elements MUST appear in the tabular report in the order they appear in the table below. For guidance on how these fields appear in the JSON format, refer to the COUNTER_SUSHI API Specification (see Section 8 below). Mandatory (M) elements MUST be included in the report. Optional (O) elements MUST only be included if requested, and if included they MUST be listed in Attributes_To_Show in the Report_Attributes header.
Table 4.f (below): Column Headings/Elements for Database Master Report and Standard Views
| Field Name (Tabular) |
DR |
DR_D1 |
DR_D2 |
| Database |
M |
M |
M |
| Publisher |
M |
M |
M |
| Publisher_ID |
M |
M |
M |
| Platform |
M |
M |
M |
| Proprietary_ID |
M |
M |
M |
| Data_Type |
O |
|
|
| Access_Method |
O |
|
|
| Metric_Type |
M |
M |
M |
| Reporting_Period_Total |
M |
M |
M |
| Mmm-yyyy |
M* |
M |
M |
*unless Exclude_Monthly_Details=True is used
4.2.3. Filters and Attributes
The following table presents the values that can be chosen for the Database Master Report and that are pre-set for the Standard Views. If a filter is not included in the request, the default applies. For the Standard Views an empty cell indicates that the filter is not applied.
Table 4.g (below): Filters/Attributes for Database Master Report and Standard Views
| Filter/Attribute |
Filters available (options for Master Report and required for Standard Views) |
| DR |
DR_D1 |
DR_D2 |
| Data_Type |
One or more or all (default) of the Data_Types applicable to the platform. |
|
|
| Access_Method |
One or all (default) of:
– Regular
– TDM |
Regular |
Regular |
| Metric_Type |
One or more or all (default) of:
– Searches_Automated
– Searches_Federated
– Searches_Regular
– Total_Item_Investigations
– Total_Item_Requests
– Unique_Item_Investigations
– Unique_Item_Requests
– Unique_Title_Investigations
– Unique_Title_Requests
– Limit_Exceeded
– No_License |
Searches_Automated
Searches_Federated
Searches_Regular
Total_Item_Investigations
Total_Item_Requests |
Limit_Exceeded
No_License |
| Exclude_Monthly_Details |
False (default) or True |
|
|
If a filter is applied to a column that doesn’t show on the report, usage for all selected attribute values is summed and the totals are presented in the report.
4.3 Title Reports
Title Reports provide a summary of activity related to content at the title level and provide a means of evaluating the impact a title has for an institution’s patrons.
Table 4.h (below): Title Master Report and Standard Views
| Report_ID |
Report_Name |
Details |
Host_Types |
| TR |
Title Master Report |
A customizable report detailing activity at the title level (journal, book, etc.) that allows the user to apply filters and select other configuration options. |
Aggregated_Full_Content
eBook
eBook_Collection
eJournal |
| TR_B1 |
Book Requests (Excluding OA_Gold) |
Reports on full-text activity for books, excluding Gold Open Access content, as Total_Item_Requests and Unique_Title_Requests. The Unique_Title_Requests provides comparable usage across book platforms. The Total_Item_Requests shows overall activity; however, numbers between sites will vary significantly based on how the content is delivered (e.g. delivered as a complete book or by chapter). |
Aggregated_Full_Content
eBook
eBook_Collection |
| TR_B2 |
Book Access Denied |
Reports on Access Denied activity for books where users were denied access because simultaneous-use licenses were exceeded or their institution did not have a license for the book. |
Aggregated_Full_Content
eBook
eBook_Collection |
| TR_B3 |
Book Usage by Access Type |
Reports on book usage showing all applicable Metric_Types broken down by Access_Type. |
Aggregated_Full_Content
eBook
eBook_Collection |
| TR_J1 |
Journal Requests (Excluding OA_Gold) |
Reports on usage of journal content, excluding Gold Open Access content, as Total_Item_Requests and Unique_Item_Requests. The Unique_Item_Requests provides comparable usage across journal platforms by reducing the inflationary effect that occurs when an HTML full text automatically displays and the user then accesses the PDF version. The Total_Item_Requests shows overall activity. |
Aggregated_Full_Content
eJournal |
| TR_J2 |
Journal Access Denied |
Reports on Access Denied activity for journal content where users were denied access because simultaneous-use licenses were exceeded or their institution did not have a license for the title. |
Aggregated_Full_Content
eJournal |
| TR_J3 |
Journal Usage by Access Type |
Reports on usage of journal content for all Metric_Types broken down by Access_Type. |
Aggregated_Full_Content
eJournal |
| TR_J4 |
Journal Requests by YOP (Excluding OA_Gold) |
Breaks down the usage of journal content, excluding Gold Open Access content, by year of publication (YOP), providing counts for the Metric_Types Total_Item_Requests and Unique_Item_Requests. Provides the details necessary to analyze usage of content in backfiles or covered by perpetual access agreement. Note that COUNTER reports do not provide access model or perpetual access rights details. |
Aggregated_Full_Content
eJournal |
4.3.1 Report Header
The table below shows the header details for the Title Master Report and its Standard Views. For the tabular reports, elements MUST appear in the exact order shown, and spelling, casing, and punctuation of labels (Column A) and fixed data elements such as report names (Column B) MUST match exactly. The JSON version of the report MUST comply with the Report_Header definition in the COUNTER_SUSHI API Specification (see Section 8 below). Entries in the table appearing in italics describe the values to include.
Table 4.i (below) Header for Title Master Report and Standard Views – Part 1 (for Books)
| Row in Tabular Report |
Label for Tabular Report (Column A) |
Value for Tabular Report (Column B) |
| TR |
TR_B1 |
TR_B2 |
TR_B3 |
| 1 |
Report_Name |
Title Master Report |
Book Requests (Excluding OA_Gold) |
Book Access Denied |
Book Usage by Access Type |
| 2 |
Report_ID |
TR |
TR_B1 |
TR_B2 |
TR_B3 |
| 3 |
Release |
5 |
5 |
5 |
5 |
| 4 |
Institution_Name |
Name of the institution the usage is attributed to. |
| 5 |
Institution_ID |
Identifier(s) for the institution in the format of {namespace}:{value}. Leave blank if identifier is not known. Multiple identifiers may be included by separating with semicolon-space (“; ”). |
| 6 |
Metric_Types |
Semicolon-space delimited list of Metric_Types included in the report. |
Total_Item_Requests; Unique_Title_Requests |
Limit_Exceeded; No_License |
Total_Item_Investigations; Total_Item_Requests; Unique_Item_Investigations; Unique_Item_Requests; Unique_Title_Investigations; Unique_Title_Requests |
| 7 |
Report_Filters |
Semicolon-space delimited list of filters applied to the data to generate the report. |
Data_Type=Book; Access_Type=Controlled; Access_Method=Regular* |
Data_Type=Book; Access_Method=Regular* |
Data_Type=Book; Access_Method=Regular* |
| 8 |
Report_Attributes |
Semicolon-space delimited list of report attributes applied to the data to generate the report. |
(blank) |
(blank) |
(blank) |
| 9 |
Exceptions |
Any exceptions that occurred in generating the report, in the format “{Exception Number}: {Exception Description} ({Data})” with multiple exceptions separated by semicolon-space (“; ”). |
| 10 |
Reporting_Period |
Date range requested for the report in the form of “Begin_Date=yyyy-mm-dd; End_Date=yyyy-mm-dd”. The “dd” of the Begin_Date is 01. The “dd” of the End_Date is the last day of the month. |
| 11 |
Created |
Date and time the report was run in RFC3339 date-time format (yyyy-mm-ddThh:mm:ssZ). |
| 12 |
Created_By |
Name of organization or system that generated the report. |
| 13 |
(blank) |
(blank) |
(blank) |
(blank) |
(blank) |
*If a Platform filter is used (see Section 3.3.8 for details), it MUST be included in Report_Filters.
Table 4.j (below): Header for Title Master Report and Standard Views – part 2 (for Journals)
| Row in Tabular Report |
Label for Tabular Report (Column A) |
Value for Tabular Report (Column B) |
| TR_J1 |
TR_J2 |
TR_J3 |
TR_J4 |
| 1 |
Report_Name |
Journal Requests (Excluding OA_Gold) |
Journal Access Denied |
Journal Usage by Access Type |
Journal Requests by YOP (Excluding OA_Gold) |
| 2 |
Report_ID |
TR_J1 |
TR_J2 |
TR_J3 |
TR_J4 |
| 3 |
Release |
5 |
5 |
5 |
5 |
| 4 |
Institution_Name |
Name of the institution the usage is attributed to. |
| 5 |
Institution_ID |
Identifier(s) for the institution in the format of {namespace}:{value}. Leave blank if identifier is not known. Multiple identifiers may be included by separating with semicolon-space (“; ”). |
| 6 |
Metric_Types |
Total_Item_Requests; Unique_Item_Requests |
Limit_Exceeded; No_License |
Total_Item_Investigations; Total_Item_Requests; Unique_Item_Investigations; Unique_Item_Requests |
Total_Item_Requests; Unique_Item_Requests |
| 7 |
Report_Filters |
Data_Type=Journal; Access_Type=Controlled; Access_Method=Regular* |
Data_Type=Journal; Access_Method=Regular* |
Data_Type=Journal; Access_Method=Regular* |
Data_Type=Journal; Access_Type=Controlled; Access_Method=Regular* |
| 8 |
Report_Attributes |
(blank) |
(blank) |
(blank) |
(blank) |
| 9 |
Exceptions |
Any exceptions that occurred in generating the report, in the format “{Exception Number}: {Exception Description} ({Data})” with multiple exceptions separated by semicolon-space (“; ”). |
| 10 |
Reporting_Period |
Date range requested for the report in the form of “Begin_Date=yyyy-mm-dd; End_Date=yyyy-mm-dd”. The “dd” of the Begin_Date is 01. The “dd” of the End_Date is the last day of the month. |
| 11 |
Created |
Date and time the report was run in RFC3339 date-time format (yyyy-mm-ddThh:mm:ssZ). |
| 12 |
Created_By |
Name of organization or system that generated the report. |
| 13 |
(blank) |
(blank) |
(blank) |
(blank) |
(blank) |
*If a Platform filter is used (see Section 3.3.8 for details), it MUST be included in Report_Filters.
4.3.2 Column Headings/Elements
The following elements MUST appear in the tabular report in the order they appear in the table below. For guidance on how these fields appear in the JSON format, refer to the COUNTER_SUSHI API Specification (see Section 8 below). Mandatory (M) elements MUST be included in the report. Optional (O) elements MUST only be included if requested, and if included they MUST be listed in Attributes_To_Show in the Report_Attributes header.
Table 4.k (below): Column Headings/Elements for Title Master Report and Standard Views
| Field Name (Tabular) |
TR |
TR_B1 |
TR_B2 |
TR_B3 |
TR_J1 |
TR_J2 |
TR_J3 |
TR_J4 |
| Title |
M |
M |
M |
M |
M |
M |
M |
M |
| Publisher |
M |
M |
M |
M |
M |
M |
M |
M |
| Publisher_ID |
M |
M |
M |
M |
M |
M |
M |
M |
| Platform |
M |
M |
M |
M |
M |
M |
M |
M |
| DOI |
M |
M |
M |
M |
M |
M |
M |
M |
| Proprietary_ID |
M |
M |
M |
M |
M |
M |
M |
M |
| ISBN |
M |
M |
M |
M |
|
|
|
|
| Print_ISSN |
M |
M |
M |
M |
M |
M |
M |
M |
| Online_ISSN |
M |
M |
M |
M |
M |
M |
M |
M |
| URI |
M |
M |
M |
M |
M |
M |
M |
M |
| Data_Type |
O |
|
|
|
|
|
|
|
| Section_Type |
O |
|
|
|
|
|
|
|
| YOP |
O |
M |
M |
M |
|
|
|
M |
| Access_Type |
O |
|
|
M |
|
|
M |
|
| Access_Method |
O |
|
|
|
|
|
|
|
| Metric_Type |
M |
M |
M |
M |
M |
M |
M |
M |
| Reporting_Period_Total |
M |
M |
M |
M |
M |
M |
M |
M |
| Mmm-yyyy |
M* |
M |
M |
M |
M |
M |
M |
M |
*unless Exclude_Monthly_Details=True is used
4.3.3. Filters and Attributes
The following table presents the values that can be chosen for the Title Master Report and that are pre-set for the Standard Views. If a filter is not included in the request, the default applies. For the Standard Views an empty cell indicates that the filter is not applied.
Table 4.l (below): Filters/Attributes for Title Master Report and Standard Views – Part 1 (for Books)
| Filter/Attribute |
Filters available (options for Master Report and required for Standard Views) |
| TR |
TR_B1 |
TR_B2 |
TR_B3 |
| Data_Type |
One or more or all (default) of the Data_Types applicable to the platform. |
Book |
Book |
Book |
| Section_Type |
One or more or all (default) of the Section_Types applicable to the platform. |
|
|
|
| YOP |
All years (default), a specific year in the format yyyy, or a range of years in the format yyyy-yyyy. Use 0001 for unknown or 9999 for articles in press.
Note that the COUNTER_SUSHI API allows the specification of multiple years and ranges separated by the vertical pipe (“|”) character. |
|
|
|
| Access_Type |
One or more or all (default) of:
– Controlled
– OA_Gold
– Other_Free_To_Read |
Controlled |
|
|
| Access_Method |
One or all (default) of:
– Regular
– TDM |
Regular |
Regular |
Regular |
| Metric_Type |
One or more or all (default) of:
– Total_Item_Investigations
– Total_Item_Requests
– Unique_Item_Investigations
– Unique_Item_Requests
– Unique_Title_Investigations
– Unique_Title_Requests
– Limit_Exceeded
– No_License |
Total_Item_Requests
Unique_Title_Requests |
Limit_Exceeded
No_License |
Total_Item_Investigations
Total_Item_Requests
Unique_Item_Investigations
Unique_Item_Requests
Unique_Title_Investigations
Unique_Title_Requests |
| Exclude_Monthly_Details |
False (default) or True |
|
|
|
Table 4.m (below): Filters/Attributes for Title Master Report and Standard Views – Part 2 (for Journals)
| Filter/Attribute |
Filters available (options for Master Report and required for Standard Views) |
| TR_J1 |
TR_J2 |
TR_J3 |
TR_J4 |
| Data_Type |
Journal |
Journal |
Journal |
Journal |
| Section_Type |
|
|
|
|
| YOP |
|
|
|
|
| Access_Type |
Controlled |
|
|
Controlled |
| Access_Method |
Regular |
Regular |
Regular |
Regular |
| Metric_Type |
Total_Item_Requests
Unique_Item_Requests |
Limit_Exceeded
No_License |
Total_Item_Investigations
Total_Item_Requests
Unique_Item_Investigations
Unique_Item_Requests |
Total_Item_Requests
Unique_Item_Requests |
| Exclude_Monthly_Details |
False (default) or True |
|
|
|
If a filter is applied to a column that doesn’t show on the report, usage for all selected attribute values is summed and the totals are presented in the report.
4.4 Item Reports
Item Reports provide a summary of activity related to content at the item level and provide a means of evaluating the impact an item has for an institution’s patrons.
Table 4.n (below): Item Master Report and Standard Views
| Report_ID |
Report_Name |
Details |
Host_Types |
| IR |
Item Master Report |
A granular, customizable report showing activity at the level of the item (article, chapter, media object, etc.) that allows the user to apply filters and select other configuration options. |
Data_Repository*
Multimedia
Repository
Scholarly_Collaboration_Network |
| IR_A1 |
Journal Article Requests |
Reports on journal article requests at the article level. This report is limited to content with a Data_Type of Article, Parent_Data_Type of Journal, and Metric_Types of Total_Item_Requests and Unique_Item_Requests.
This Standard View must be provided only if (a) it is clear for all articles in IR whether they are journal articles or not and (b) the parent item is known for all journal articles. |
Repository
Scholarly_Collaboration_Network |
| IR_M1 |
Multimedia Item Requests |
Reports on multimedia requests at the item level. |
Multimedia |
*Data repositories may choose to conform to the Code of Practice Release 5 or, alternatively, may wish to work with the Code of Practice for Research Data.
4.4.1 Report Header
The table below shows the header details for the Item Master Report and its Standard Views. For the tabular reports, elements MUST appear in the exact order shown, and spelling, casing and punctuation of labels (Column A) and fixed data elements such as report names (Column B) MUST match exactly. The JSON version of the report MUST comply with the Report_Header definition in the COUNTER_SUSHI API Specification (see Section 8 below). Entries in the table appearing in italics describe the values to include.
Table 4.o (below): Header for Item Master Report and Standard Views
| Row in Tabular Report |
Label for Tabular Report (Column A) |
Value for Tabular Report (Column B) |
| IR |
IR_A1 |
IR_M1 |
| 1 |
Report_Name |
Item Master Report |
Journal Article Requests |
Multimedia Item Requests |
| 2 |
Report_ID |
IR |
IR_A1 |
IR_M1 |
| 3 |
Release |
5 |
5 |
5 |
| 4 |
Institution_Name |
Name of the institution the usage is attributed to. |
| 5 |
Institution_ID |
Identifier(s) for the institution in the format of {namespace}:{value}. Leave blank if identifier is not known. Multiple identifiers may be included by separating with semicolon-space (“; ”). |
| 6 |
Metric_Types |
Semicolon-space delimited list of Metric_Types included in the report. |
Total_Item_Requests; Unique_Items_Requests |
Total_Item_Requests |
| 7 |
Report_Filters |
Semicolon-space delimited list of filters applied to the data to generate the report. |
Data_Type=Article; Parent_Data_Type=Journal; Access_Method=Regular* |
Data_Type=Multimedia; Access_Method=Regular* |
| 8 |
Report_Attributes |
Semicolon-space delimited list of report attributes applied to the data to generate the report. |
(blank) |
(blank) |
| 9 |
Exceptions |
Any exceptions that occurred in generating the report, in the format “{Exception Number}: {Exception Description} ({Data})” with multiple exceptions separated by semicolon-space (“; ”). |
| 10 |
Reporting_Period |
Date range requested for the report in the form of “Begin_Date=yyyy-mm-dd; End_Date=yyyy-mm-dd”. The “dd” of the Begin_Date is 01. The “dd” of the End_Date is the last day of the month. |
| 11 |
Created |
Date and time the report was run in RFC3339 date-time format (yyyy-mm-ddThh:mm:ssZ). |
| 12 |
Created_By |
Name of organization or system that generated the report. |
| 13 |
(blank) |
(blank) |
(blank) |
(blank) |
*If a Platform filter is used (see Section 3.3.8 for details), it MUST be included in Report_Filters.
4.4.2 Column Headings/Elements
The following elements MUST appear in the tabular report in the order they appear in the table below. For guidance on how these fields appear in the JSON format, refer to the COUNTER_SUSHI API Specification (see Section 8 below). Mandatory (M) elements MUST be included in the report. The optional (O) Parent and Component elements MUST only be included if requested via Include_Parent_Details and Include_Component_Details, respectively (they are not supposed to be selected individually). If they are included then the corresponding Include_Parent_Details=True or Include_Component_Details=True MUST be included in the Report_Attributes header. The other optional (O) elements MUST only be included if requested, and if included they MUST be listed in Attributes_To_Show in the Report_Attributes header.
Table 4.p (below): Column Headings/Elements for Item Master Report and Standard Views
| Field Name (Tabular) |
IR |
IR_A1 |
IR_M1 |
| Item |
M |
M |
M |
| Publisher |
M |
M |
M |
| Publisher_ID |
M |
M |
M |
| Platform |
M |
M |
M |
| Authors |
O |
M |
|
| Publication_Date |
O |
M |
|
| Article_Version |
O |
M |
|
| DOI |
M |
M |
M |
| Proprietary_ID |
M |
M |
M |
| ISBN |
M |
|
|
| Print_ISSN |
M |
M |
|
| Online_ISSN |
M |
M |
|
| URI |
M |
M |
M |
| Parent_Title |
O |
M |
|
| Parent_Authors |
O |
M |
|
| Parent_Publication_Date |
O |
|
|
| Parent_Article_Version |
O |
M |
|
| Parent_Data_Type |
O |
|
|
| Parent_DOI |
O |
M |
|
| Parent_Proprietary_ID |
O |
M |
|
| Parent_ISBN |
O |
|
|
| Parent_Print_ISSN |
O |
M |
|
| Parent_Online_ISSN |
O |
M |
|
| Parent_URI |
O |
M |
|
| Component_Title |
O |
|
|
| Component_Authors |
O |
|
|
| Component_Publication_Date |
O |
|
|
| Component_Data_Type |
O |
|
|
| Component_DOI |
O |
|
|
| Component_Proprietary_ID |
O |
|
|
| Component_ISBN |
O |
|
|
| Component_Print_ISSN |
O |
|
|
| Component_Online_ISSN |
O |
|
|
| Component_URI |
O |
|
|
| Data_Type |
O |
|
|
| YOP |
O |
|
|
| Access_Type |
O |
M |
|
| Access_Method |
O |
|
|
| Metric_Type |
M |
M |
M |
| Reporting_Period_Total |
M |
M |
M |
| Mmm-yyyy |
M* |
M |
M |
*unless Exclude_Monthly_Details=True is used
4.4.3. Filters and Attributes
The following table presents the values that can be chosen for the Item Master Report and that are pre-set for the Standard Views. If a filter is not included in the request, the default applies. For the Standard Views an empty cell indicates that the filter is not applied.
Table 4.q (below): Filters/Attributes for Item Master Report and Standard Views
| Filter/Attribute |
Filters available (options for Master Report and required for Standard Views) |
| IR |
IR_A1 |
IR_M1 |
| Data_Type |
One or more or all (default) of the Data_Types applicable to the platform. |
Article |
Multimedia |
| YOP |
All years (default), a specific year in the format yyyy, or a range of years in the format yyyy-yyyy. Use 0001 for unknown or 9999 for articles in press.
Note that the COUNTER_SUSHI API allows the specification of multiple years and ranges separated by the vertical pipe (“|”) character. |
|
|
| Access_Type |
One or more or all (default) of:
– Controlled
– OA_Gold
– Other_Free_To_Read |
|
|
| Access_Method |
One or all (default) of:
– Regular
– TDM |
Regular |
Regular |
| Metric_Type |
One or more or all (default) of:
– Total_Item_Investigations
– Total_Item_Requests
– Unique_Item_Investigations
– Unique_Item_Requests
– Limit_Exceeded
– No_License |
Total_Item_Requests
Unique_Item_Requests |
Total_Item_Requests |
| Include_Parent_Details |
False (default) or True |
|
|
| Include_Component_Details |
False (default) or True |
|
|
| Exclude_Monthly_Details |
False (default) or True |
|
|
If a filter is applied to a column that doesn’t show on the report, usage for all selected attribute values is summed and the totals are presented in the report.
Menu
