4.1 Platform 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 Code}: {Exception Message} ({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 elements 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 other elements MUST only be included in the Master Report if requested (R), 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

Element Name (Tabular)

PR

PR_P1

Platform

M

M

Data_Type

R

Access_Method

R

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.