SUSHI Access to HighWire Press Counter Reports

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> <html> <head> <title>SUSHI Access to HighWire Press Counter Reports</title> <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"> <link rel="stylesheet" type="text/css" href="/layout.css"> <link href="/sushi.css" rel="stylesheet" type="text/css"> </head> <body> <div id="top"> <div class="wrapper"> <div id="top_links">  <a href="http://highwire.stanford.edu/about/">About HighWire</a> | <a href="http://highwire.stanford.edu/news/">News & Events</a> | <a href="http://highwire.stanford.edu/cgi/feedback">Contact Us</a></div> </div> </div> <div id="content"> <div class="wrapper"> <div id="header"> <div id="logo"><a href="http://highwire.stanford.edu"><img src="http://highwire.stanford.edu/icons/3/logo.jpg" alt="highwire press"/></a></div>  </div> <div id="main" class="wrapper_border"> <div id="subpage_left_col"> <div style="width:140px;line-height:1.6;font-style:italic;padding-top:20px;padding-left:14px;color:#8b8b8b;font-size:12px;"></div> </div> <div id="subpage_center_col" style=""> <div id="subpage_content" style="width:730px;border:0;"> <h2>Access to HighWire-hosted journal COUNTER reports through the Standardized Usage Statistics Harvesting Initiative (SUSHI) protocol</h2> <p>HighWire Press provides access to COUNTER 5 reports through the Standardized Usage Statistics Harvesting Initiative (SUSHI) protocol. Additional information about the SUSHI COUNTER 5 protocol can be found at the <a href="https://app.swaggerhub.com/apis/COUNTER/counter-sushi_5_0_api/" style="color:blue">SUSHI website</a>. Additional information about COUNTER 5 can be found at the <a href="https://www.projectcounter.org/code-of-practice-five-sections/abstract/" style="color:blue">COUNTER website</a>.</p> <h3>Access for institutional administrators</h3> To harvest COUNTER usage statistics via the SUSHI protocol, you will need to have an account on the <a href="http://highwire.org/librarians/" style="color:blue">HighWire Portal</a>. Register <a href="http://highwire.org/cgi/registration" style="color:blue">here</a> and follow the instructions to create an account and associate your HighWire subscriptions if you do not already have one. Note that you will not be able to harvest any data until you associate your HighWire subscriptions to your new HighWire Portal account. <p>To be able to harvest reports from HighWire-hosted publications, you'll need to provide an api_key for all actions. Set your api key to the primary e-mail address associated with your HighWire Portal account, followed by "|", and then your portal password. For example, "api_key=user@highwire.org|Us3rPW". See the <a href="https://app.swaggerhub.com/apis/COUNTER/counter-sushi_5_0_api/" style="color:blue">SUSHI website</a> for instructions on harvesting specific reports. </p> <h3>Access for publishers</h3> To harvest COUNTER usage statistics via the SUSHI protocol, please <a href="mailto:sushi@highwire.org" style="color:blue">contact HighWire</a> to request a SUSHI api_key for publishers. Please include the name and email address of your organization's point of contact, the name of your organization, the URL of your organization's web site, and the primary purpose for which you will be using the SUSHI API. <p>To be able to harvest reports from HighWire-hosted publications, you'll need to provide an api_key for all actions. Set your api key to the unique key provided by HighWire Customer Service. For example, "api_key=860fe5df-0482-11e9-a62c-02ac19b86acf". See the <a href="https://app.swaggerhub.com/apis/COUNTER/counter-sushi_5_0_api/" style="color:blue">SUSHI website</a> for instructions on harvesting specific reports. </p> <p>Publishers must precede the customer_id of all of their requests with the publisher id provided by HighWire followed by "|". For example, "customer_id=hwpubid|INST12345</p> <h2>Service URL</h2> <p><a href="https://hwdpapi.highwire.org/sushi" style="color:blue">https://hwdpapi.highwire.org/sushi</a></p> <p>This service is delivering COUNTER version 5 reports.</p> <h2>Example service calls</h2> <h3>Institutional administrators</h3> <p>https://hwdpapi.highwire.org/sushi/status?api_key=user@highwire.org|Us3rPW</p> <p>https://hwdpapi.highwire.org/sushi/members?customer_id=user@highwire.org&api_key=user@highwire.org|Us3rPW</p> <p>https://hwdpapi.highwire.org/sushi/reports?api_key=user@highwire.org|Us3rPW</p> <p>https://hwdpapi.highwire.org/sushi/reports/PR?customer_id=user@highwire.org&begin_date=2018-10&end_date=2018-11&attributes_to_show=Data_Type|Access_Method&api_key=user@highwire.org|Us3rPW</p> <p>https://hwdpapi.highwire.org/sushi/reports/TR?customer_id=user@highwire.org&begin_date=2018-10&end_date=2018-11&attributes_to_show=YOP&api_key=user@highwire.org|Us3rPW</p> <h3>Publishers</h3> <p>https://hwdpapi.highwire.org/sushi/status?api_key=860fe5df-0482-11e9-a62c-02ac19b86acf</p> <p>https://hwdpapi.highwire.org/sushi/members?customer_id=hwpubid|INST12345&api_key=860fe5df-0482-11e9-a62c-02ac19b86acf</p> <p>https://hwdpapi.highwire.org/sushi/reports?api_key=860fe5df-0482-11e9-a62c-02ac19b86acf</p> <p>https://hwdpapi.highwire.org/sushi/reports/PR?customer_id=hwpubid|MEMINST12345&begin_date=2018-10&end_date=2018-11&attributes_to_show=Data_Type|Access_Method&api_key=860fe5df-0482-11e9-a62c-02ac19b86acf</p> <p>https://hwdpapi.highwire.org/sushi/reports/TR?customer_id=hwpubid|MEMINST12345&begin_date=2018-10&end_date=2018-11&attributes_to_show=YOP&api_key=860fe5df-0482-11e9-a62c-02ac19b86acf</p> <h2>Consortium reports</h2> The <a href="https://www.projectcounter.org/code-of-practice-five-sections/abstract/" style="color:blue">COUNTER 5 Code of Practice</a> does not include consortium reports. You must use SUSHI to obtain a list of consortium members and query for the usage of each member separately. HighWire has provided this <a href="http://highwire.org/counter5_consortium_info.dtl" style="color:blue">guide</a> to assist you in doing so. <br/><br/> <address><a href="mailto:sushi@highwire.org" style="color:blue">Contact HighWire</a></address> <br/><br/><br/> </div> </div> <div class="clear"></div> </div> </div> <div id="footer"> <div class="wrapper"> <div class="left"> © 2018 HighWire Press, Inc. All rights reserved. Privacy Policy. HighWire Press is a Registered Trademark. </div> <div class="clear"></div> </div> </div> </div> </body> </html>

CINXE.COM

SUSHI Access to HighWire Press Counter Reports