COUNTER SUSHI

COUNTER_SUSHI — это RESTful-интерфейс, возвращающий отчеты COUNTER 5 в формате JSON, позволяющий получать сведения об использовании ЭБС Znanium в других приложениях. URL-адрес SUSHI состоит из четырех основных разделов: 

• базовый URL-адрес SUSHI-сервера
• конкретный запрашиваемый отчет
• учетные данные аутентификации
• параметры отчета, такие как диапазон дат, список метрик, и т.д.

Обязательные параметры для всех запросов выдаются службой поддержки Znanium:

• customer_id - идентификатор клиента ЭБС
• api_key - ключ api-аутентификации

Ниже представлен перечень ресурсов и параметров, необходимых для успешной выгрузки отчетов COUNTER_SUSHI.

https://znanium.ru/counter-sushi/status
Возвращает текущий статус службы отчетов, поддерживаемых API.

https://znanium.ru/counter-sushi/reports
Возвращает детальный список поддерживаемых отчетов. С подробным описанием и прямой ссылкой на его выгрузку.

Необязательные параметры:
search - поисковая фраза, позволяющая отфильтровать отчеты по названию.

https://znanium.ru/counter-sushi/reports/<report_name>
Возвращает json-отчет COUNTER 5 по заданным параметрам. Вместо <report_name> указывается наименование отчета.
Полный перечень поддерживаемых отчетов: pr, pr_p1, dr, dr_d1, dr_d2, tr, tr_b1, tr_b2, tr_b3, tr_j1, tr_j2, tr_j3, tr_j4.

Обязательные параметры:
begin_date - дата начала отчетного периода.
end_date - дата окончания отчетного периода.
Даты указываются в формате гггг-мм-дд или гггг-мм. 
Статистика предоставляется кратно месяцу, поэтому даты, не относящиеся к концу или началу месяца будут преобразованы соответствующим образом.

Важно отметить, что необязательные параметры применимы только к Master-отчетам pr, dr, tr, в то время как остальные являются их стандартными представлениями с фиксированным набором метрик и фильтров.
Множественные значения параметров указываются в виде перечня, разделенного символом "|". Если параметр не указан, будет использован полный перечень для текущего отчета.

Необязательные параметры:

metric_type - перечень возвращаемых метрик отчета.
Пример: Total_Item_Investigations|Unique_Item_Investigations|Unique_Item_Requests|Unique_Title_Requests|No_License|Limit_Exceeded

data_type - перечень используемых в отчете типов данных.
Пример: Platform|Book|Journal|Article

access_method - перечень методов доступа, используемых в отчете.
Пример: Regular|TDM

access_type - перечень методов доступа, используемых в отчете.
Данный параметр применим только для отчетов TR.
Пример: Controlled|OA_Gold

yop - год публикации изданий, представленных в отчете.
Данный параметр применим только для отчетов TR.
Пример: 2001|2006

granularity - степень детализации отчета. По умолчанию используется значние "month" (помесячная статистика), альтернативой является "totals" - за весь выбранный период.

Более подробную информацию можно найти в официальной документации по COUNTER 5.