Appendix G: Fields Mapped to Reports and Views

The following tables provides mappings of COUNTER report fields and the reports and views to which they apply.

The first column in each table is the element name exactly as it should appear on the COUNTER reports. The second column provides a general representation as to how the field would appear in the JSON when retrieved via COUNTER_SUSHI (if there are differences between this table and the SUSHI_COUNTER OpenAPI specification, the SUSHI_COUNTER specification is considered correct.)

A column appears for each report or view. An “M” means the field must be included as a column in the Excel version of the report and that element must appear in the JSON if there is data to present (empty fields are omitted). An “O” in the column means the field is optional. For the tabular version of reports and views, the content provider’s user interface would be used to indicate which optional fields to include. For COUNTER_SUSHI, the Attributes_To_Show and Fields_To_Show parameters would be used, when allowed by the COUNTER_SUSHI specification.

Table G.1: COUNTER Report Fields Mapped to the Platform Report and Views in which they Appear

Element Name (tabular)	Description	Allowed values/data requirements	PR	PR-P1
Platform	Identifier for the host where the usage activity occurred.	Must be valid Platform Name as registered with COUNTER	M	M
Data_Type			O
Access_Type	Identifies the access control mechanism in play for the activity.	Controlled OA_Gold Other_Free-to_read	O
Access_Method	Identifies if the usage activity was “Regular” usage (a user doing research on a content site) or if the usage was for the purpose of retrieving content for Text and Data Mining (TDM)	Regular TDM	O
Metric_Type	Category of usage being tracked. Sum for the metric type across the platform	Searches_Platform Total_Investigations Total_Requests Unique_Item_Investigations Unique_Item_Requests Unique_Title_Investigations Unique_Title_Requests	M	M
Reporting_Period_Total	Sum of monthly figures in the current row. This ONLY appears in the tabular version of this report.	Whole number > 0	M	M
Mmm-yyyy	Monthly totals for the platform and metric type	For tabular report, values can be >=0. For SUSHI >0 (zero usage excluded)	M	M

Table G.2: COUNTER Report Fields Mapped to the Title Report and Views in which they Appear

Element Name (tabular)	COUNTER _SUSHI (JSON) Representation	TR	TR_B1	TR_B2	TR_B3	TR_J1	TR_J2	TR_J3	TR_J4
Title	“Title”: “string”	M	M	M		M	M
Publisher	“Publisher” : “string”	M	M	M		M	M
Publisher_ID	“Publisher_ID”: [{“<type>”: “string”}]	M	M	M		M	M
Platform	“Platform” : “string”	M	M	M		M	M
DOI	“Item_ID”:[{“doi”:”string”}]	M	M	M		M	M
Proprietary_ID	“Item_ID”:[{“<namespace>”:”string”}]	M	M	M		M	M
ISBN	“Item_ID”:[{“isbn”:”string”}]	M	M	M
Print_ISSN	“Item_ID”:[{“Print_ISSN”:”string”}]	M	M	M		M	M
Online_ISSN	“Item_ID”:[{“Online_ISSN”:”string”}]	M	M	M		M	M
URI	“Item_ID”:[{“uri”:”string”}]	M	M	M		M	M
Data_Type	“Data_Type”:”string”	O
Section_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O
YOP	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,“YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:<int}]}]	O	M	M			M
Access_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,“Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O				M
Access_Method	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,“Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O
Metric_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	M	M	M		M	M
Reporting_Period_Total	n/a	M	M	M		M	M
Mmm-yyyy	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,“Count”:int}]}]	M	M	M		M	M

Table G.3: COUNTER Report Fields Mapped to the Database Report and Views in which they Appear

Element Name (tabular)	COUNTER _SUSHI (JSON) Representation	DR	DR_D1	DR_D2
Database	“Database”:”string”	M	M	M
Publisher	“Publisher” : “string”	M	M	M
Publisher_ID	“Publisher_ID”: [{“<type>”: “string”}]	M	M	M
Platform	“Platform” : “string”	M	M	M
DOI	“Item_ID”:[{“doi”:”string”}]	M	M	M
Proprietary_ID	“Item_ID”:[{“<namespace>”:”string”}]	M	M	M
Data_Type	“Data_Type”:”string”	O
YOP	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,“YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:<int}]}]	O
Access_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,“Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O
Metric_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	M	M	M
Reporting_Period_Total	n/a	M	M	M
Mmm-yyyy	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,“Count”:int}]}]	M	M	M

Table G.4: COUNTER Report Fields Mapped to the Item Report and Views in which they Appear

Element Name (tabular)	COUNTER _SUSHI (JSON) Representation	IR	IR_A1	IR_M1
Item	“Item”:”string	M	M
Publisher	“Publisher” : “string”	M	M
Publisher_ID	“Publisher_ID”: [{“<type>”: “string”}]	M	M
Platform	“Platform” : “string”	M	M
Authors	“Item_Contributors”: [{“author”:”string”}]	O	M
Publication_Date	“Item_Dates”: [{“PubDate”:”date”}]	O
Article_Version	“Item_Attributes”: [{“Article_Version”:”string”}]	O
DOI	“Item_ID”:[{“doi”:”string”}]	O	M
Proprietary_ID	“Item_ID”:[{“<namespace>”:”string”}]	O
ISBN	“Item_ID”:[{“isbn”:”string”}]	O
Print_ISSN	“Item_ID”:[{“Print_ISSN”:”string”}]	O
Online_ISSN	“Item_ID”:[{“Online_ISSN”:”string”}]	O
URI	“Item_ID”:[{“uri”:”string”}]	O	M
Parent_Title	“Parent_Item”:{ … “Title”:”string”,…}	O	M
Parent_Authors	“Parent_Item”:{ … “Item_Contributors”: [{“author”:”string”}],…}	O
Parent_Publication_Date	“Parent_Item”:{ … “Item_Dates”: [{“PubDate”:”date”}]…}	O
Parent_Article_Version	“Parent_Item”:{ … “Item_Attributes”: [{“Article_Version”:”string”}]…}	O
Parent_Data_Type	“Parent_Item”:{ … “Data_Type”:”string”…}	O	M
Parent_DOI	“Parent_Item”:{ … “Item_ID”:[{“doi”:”string”}]…}	O	M
Parent_Proprietary_ID	“Parent_Item”:{ … “Item_ID”:[{“<namespace>”:”string”}]…}	O
Parent_ISBN	“Parent_Item”:{ … “Item_ID”:[{“isbn”:”string”}]…}	O
Parent_Print_ISSN	“Parent_Item”:{ … “Item_ID”:[{“Print_ISSN”:”string”}]…}	O	M
Parent_Online_ISSN	“Parent_Item”:{ … “Item_ID”:[{“Online_ISSN”:”string”}]…}	O	M
Parent_URI	“Parent_Item”:{ … “Item_ID”:[{“uri”:”string”}]…}	O
Component_Title	“Component_Item”:{ … “Title”:”string”,…}	O
Component_Authors	“Component_Item”:{ … “Item_Contributors”: [{“author”:”string”}],…}	O
Component_Publication_Date	“Component_Item”:{ … “Item_Dates”: [{“PubDate”:”date”}]…}	O
Component_Article_Version	“Component_Item”:{ … “Item_Attributes”: [{“Article_Version”:”string”}]…}	O
Component_Data_Type	“Component_Item”:{ … “Data_Type”:”string”…}	O
Component_DOI	“Component_Item”:{ … “Item_ID”:[{“doi”:”string”}]…}	O
Component_Proprietary_ID	“Component_Item”:{ … “Item_ID”:[{“<namespace>”:”string”}]…}	O
Component_ISBN	“Component_Item”:{ … “Item_ID”:[{“isbn”:”string”}]…}	O
Component_Print_ISSN	“Component_Item”:{ … “Item_ID”:[{“Print_ISSN”:”string”}]…}	O
Component_Online_ISSN	“Component_Item”:{ … “Item_ID”:[{“Online_ISSN”:”string”}]…}	O
Component_URI	“Component_Item”:{ … “Item_ID”:[{“uri”:”string”}]…}	O
Data_Type	“Data_Type”:”string”	O
Section_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O
YOP	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,“YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:<int}]}]	O	M
Access_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,“Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O
Access_Method	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,“Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	O
Metric_Type	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,”Count”:int}]}]	M	M
Reporting_Period_Total	n/a	M	M
Mmm-yyyy	“Performance”: [{“Period”:{“Begin”:”yyyy-mm-dd”,”End”:”yyyy-mm-dd”}, “Category”:”string”, “Section_Type”:”string”,”YOP”:”yyyy”,”Access_Type”:”string”,”Access_Method”:”string”,”Instance”: [{“Metric_Type”:”string”,“Count”:int}]}]	M	M

Appendix G: Fields Mapped to Reports and Views

Gold, Silver and Bronze Sponsors