This is a fake COUNTER API/SUSHI provider and COUNTER 5.0 / 5.1 report generator. This server generates random usage data for testing purposes. All usage numbers are randomly generated and should not be used for any real analysis or decision-making.
This is a test server that generates fake COUNTER reports. The data is:
The platform name controls which types of usage data are generated:
You can combine letters (e.g., platform=mdt for all types). If no letters are specified, it defaults to title-based usage.
Platforms with an 'a' in their name implement the COUNTER best practice for
Generative and Agentic AI usage metrics (phase 2 draft, October 2026), an optional
extension of Release 5.1. It adds the Agent Access_Method and these Metric_Types:
| Metric_Type | Reports |
|---|---|
AI_Responses_Generated |
PR |
Total_AI_Investigations, Unique_AI_Investigations |
PR, DR, TR, IR |
Total_AI_Requests, Unique_AI_Requests |
PR, DR, TR, IR |
Total_Retrieved_Investigations, Total_Retrieved_Requests |
PR, DR, TR, IR |
As the best practice requires, AI usage is only included in the PR, DR, TR and IR reports
(never in Standard Views), and only when it is called for using both the
access_method and the metric_type filters. AI metrics are always reported against
Access_Method Agent, and the requested values are listed in Report_Filters. Examples
(Platform Report for platform ta, i.e. title-based usage with AI usage metrics support):
/r51/reports/pr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=ta&access_method=Regular|TDM|Agent&metric_type=Searches_Platform|Total_Item_Investigations|Unique_Item_Investigations|Total_Item_Requests|Unique_Item_Requests|Unique_Title_Investigations|Unique_Title_Requests|AI_Responses_Generated|Total_AI_Investigations|Unique_AI_Investigations|Total_AI_Requests|Unique_AI_Requests|Total_Retrieved_Investigations|Total_Retrieved_Requests&attributes_to_show=Access_Method/r51/reports/pr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=ta&access_method=Agent&metric_type=AI_Responses_Generated|Total_AI_Investigations|Unique_AI_Investigations|Total_AI_Requests|Unique_AI_Requests|Total_Retrieved_Investigations|Total_Retrieved_Requests&attributes_to_show=Access_MethodWithout an 'a' in the platform name (and in all R5.0 reports), the server behaves like a
platform that does not support the extension: Agent and the AI Metric_Types are
ignored and reported with Exception 3060 (Invalid ReportFilter Value). The same
applies to AI_Responses_Generated requested in a report other than PR.
t (no AI usage support), returning
the traditional usage and Exception 3060: /r51/reports/pr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=t&access_method=Agent&metric_type=AI_Responses_Generated|Total_AI_Investigations|Unique_AI_Investigations|Total_AI_Requests|Unique_AI_Requests|Total_Retrieved_Investigations|Total_Retrieved_Requests&attributes_to_show=Access_MethodAll data report endpoints require:
customer_id - Customer identifierbegin_date - Start date (YYYY-MM or YYYY-MM-DD)end_date - End date (YYYY-MM or YYYY-MM-DD)Optional parameters:
platform - Platform name (controls usage types via m/d/t letters and AI usage metrics support via 'a')requestor_id - Requestor identifierapi_key - May be used to configure the data generation. Currently supported keys are: platform:PlatformName;scale:100 which override the platform name and control how much data is generated, respectivelyThe api_key may also make the server return simulated errors instead of data - a Cloudflare challenge page (error:cloudflare) or any COUNTER exception (error:exception;error.code:<code>), optionally only for a part of the requests (error.rate). See Simulated Errors and Exceptions for details.
Non-data endpoints have different parameter requirements:
/status) - No required parameters. Optional: platform/r51/platforms) - Required: customer_id. Optional: requestor_id, api_key/members) - Required: customer_id. Optional: requestor_id, api_key, platform/reports) - Required: customer_id. Optional: requestor_id, api_key, platform/r51/reports/ir?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdtJournal article requests only
Example: /r51/reports/ir_a1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt
/r51/reports/ir_m1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_b1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_b2?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_b3?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_j1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_j2?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_j3?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/tr_j4?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/dr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/dr_d1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/dr_d2?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r51/reports/pr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdtPlatform usage standard view
Example: /r51/reports/pr_p1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt
/r50/reports/ir?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/ir_a1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/ir_m1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_b1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_b2?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_b3?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_j1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_j2?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_j3?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/tr_j4?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/dr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/dr_d1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/dr_d2?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/pr?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdt/r50/reports/pr_p1?customer_id=test123&begin_date=2025-01&end_date=2025-01&platform=mdtThese endpoints provide service information and do not require date parameters.
Returns the current status of the reporting service. This endpoint is public and does not require authentication.
/r51/status/r50/status or /statusExample: /r51/status
Returns the list of platforms supported for the request credentials. This is the optional COUNTER R5.1.1 Platforms common extension. Sashimi2 generates reports for a single effective platform, so the response contains one platform with the same service description as /status.
Required parameters:
customer_id - Customer identifierOptional parameters:
requestor_id - Requestor identifierapi_key - API key for configuration (may override the platform name)The Platform_Parameter value is the platform to use on other API paths. When api_key contains platform:Name, that name is returned; otherwise the customer ID is used (matching how reports resolve the platform).
Example: /r51/platforms?customer_id=test123
Returns the institutions associated with the customer ID. For this implementation, returns a single member derived from the customer_id.
Required parameters:
customer_id - Customer identifierOptional parameters:
requestor_id - Requestor identifierapi_key - API key for configurationplatform - Platform name
/r50/members?customer_id=test123 or /members?customer_id=test123Example: /r51/members?customer_id=test123
Note: R5.0 uses Name field instead of Institution_Name in the response.
Returns the list of reports supported by the COUNTER API server for the customer. The available reports are dynamically determined based on the platform name letters (m, d, t):
If no letters are specified, it defaults to title-based usage.
Required parameters:
customer_id - Customer identifierOptional parameters:
requestor_id - Requestor identifierapi_key - API key for configurationplatform - Platform name (controls which reports are listed via m/d/t letters)
/r50/reports?customer_id=test123&platform=mdt or /reports?customer_id=test123&platform=mdtExamples:
/r51/reports?customer_id=test123&platform=mdt/r51/reports?customer_id=test123&platform=m/r51/reports?customer_id=test123&platform=d/r51/reports?customer_id=test123&platform=tNote: R5.0 reports use "Master Report" suffix in names (e.g., "Platform Master Report" instead of "Platform Report") and do not include First_Month_Available and Last_Month_Available fields.
Adding error:<kind> to the api_key makes every endpoint return a simulated error instead of data. This is useful for testing how SUSHI clients deal with misbehaving providers. Supported kinds:
error:cloudflare - HTTP 403 Cloudflare challenge with the cf-mitigated: challenge header and a minimal HTML page saying it is simulated, e.g. /r51/reports/tr?customer_id=test&begin_date=2025-01&end_date=2025-01&api_key=error:cloudflare. Options (values 1/true/yes/on or 0/false/no/off):error.simulate_content - return a full page resembling the real Cloudflare "Just a moment..." challenge instead, e.g. api_key=error:cloudflare;error.simulate_content:1error.no_header - leave out the cf-mitigated header, e.g. api_key=error:cloudflare;error.simulate_content:1;error.no_header:1error:exception - COUNTER exception given by error.code (see Simulated COUNTER exceptions), e.g. /r51/reports/tr?customer_id=test&begin_date=2025-01&end_date=2025-01&api_key=error:exception;error.code:2020The error can be configured further with error.<param>:<value> keys:
error.rate - probability (a number from 0 to 1) that a request gets the error, defaults to 1 (always). The decision is truly random, so retrying the same request may succeed; report data itself stays deterministic. E.g. /r51/reports/tr?customer_id=test&begin_date=2025-01&end_date=2025-01&api_key=error:cloudflare;error.rate:0.5error:exception;error.code:<code> returns one of the COUNTER Release 5.1.1 exceptions (Code of Practice, Appendix D). R5.0 endpoints add the Severity field. Parameters:
error.code (required) - exception code from the table belowerror.http_status - overrides the HTTP status of the response (100-599)error.last_day - day of month (1-31), only for 3031error.before - month in YYYY-MM format, only for 3032| Code | HTTP status | Behavior |
|---|---|---|
| 1000, 1010 | 503 | exception object is the response body; applies to all endpoints |
| 1011 | 202 | same as above |
| 1020 | 429 | same as above |
| 1030, 3020 | 400 | same as above |
| 2000, 2020 | 401 | same as above |
| 2010, 2011 | 403 | same as above |
| 3030 | 200 | report with no Report_Items |
| 3031 | 200 | see below |
| 3032 | 200 | see below |
| 3040, 3050, 3060, 3061, 3062, 3063, 3070 | 200 | report with the exception in its header |
Exceptions with HTTP status 200 are put into Report_Header.Exceptions of report endpoints; other endpoints are not affected by them.
3031 (Usage Not Ready for Requested Dates) - usage of the previous month (and later) is not ready yet. With error.last_day:N this is the case only up to day N of the current month (UTC); afterwards normal reports are returned. Requests including the previous month get usage only for the older months (End_Date is moved accordingly) with the not ready months listed in the exception Data. Requests for older months are not affected, requests for not ready months only get an empty report. E.g. error.code:3031;error.last_day:53032 (Usage No Longer Available for Requested Dates) - usage before the error.before month is no longer available (all usage when not given). Requests including such months get usage only for the newer months (Begin_Date is moved accordingly) with the unavailable months listed in the exception Data. Requests for newer months are not affected, requests for unavailable months only get an empty report. E.g. error.code:3032;error.before:2025-03