통계조회
• DOI 접두사별 DOI 이용 건수를 조회하는 API.
• 이용 통계는 파라미터 groupBy 값에 따라 연도별(Y), 월별(M), 일별(D)로 합산된 결과가 제공됨.
• 이용 통계는 요청 파라미터에 포함된 ID와 Prefix로 등록된 DOI에 대해서만 조회 가능.
• DOI별 이용 건수를 조회하는 API.
• HTTP Method : GET
• 파라미터
|
이름 |
의미 |
설명 |
필수 |
기본값 |
|---|---|---|---|---|
|
id |
로그인ID |
DOI등록관리시스템 로그인 ID |
Y |
- |
|
key |
API 키 |
등록기관별로 발급된 API key로, DOI등록관리시스템에 로그인 한 후 자신의 정보 페이지에서 조회 |
Y |
- |
|
prefix |
조회대상 DOI접두사 |
|
N |
- |
|
type |
콘텐트 종류 |
• article: 학술논문 • reference: 참조문헌 • paper: 프로시딩페이퍼 • report: 연구보고서 • dataset: 과학데이터 • property: 지적재산권 • general: 범용데이터 • book: 단행본 |
N |
현재 미적용 |
|
doi |
조회대상 DOI |
N |
1 |
|
|
Date |
조회범위 시작일자 |
yyyymmdd 형식 |
N |
이전달 첫일 20170901 |
|
endDate |
조회범위 끝일자 |
yyyymmdd 형식 |
N |
이전달 말일 20170930 |
|
groupBy |
집계 단위 기간 |
• 50. Y: 연도별 건수 • 50. M: 연월별 건수 • 50. D: 일별 건수 |
N |
M |
|
page |
조회대상 페이지 |
1부터 시작 |
N |
1 |
|
max |
최대 조회 건수 |
1 ~ 300 |
N |
50 |
• Content-Type: text/xml: charset=utf8
• 형식
|
태그 |
반복 |
값 |
설명 |
|
|---|---|---|---|---|
|
reponse |
1 |
|
|
|
|
@version |
1 |
버전 |
“1”로 고정 |
|
|
summary |
1 |
|
|
|
|
result |
1 |
• SUCCESS: 성공 • FAIL: 오류 |
|
|
|
message |
0..1 |
메시지 |
|
|
|
query |
1 |
사용된 파라미터 값 |
요청된 값과 다를 수도 있다 |
|
|
prefix |
1 |
조회대상 DOI접두사 |
|
|
|
doi |
1 |
조회대상 DOI |
|
|
|
Date |
1 |
조회범위 시작일자 |
|
|
|
endDate |
1 |
조회범위 끝일자 |
|
|
|
groupBy |
1 |
집계 단위 기간 |
|
|
|
page |
1 |
조회대상 페이지 |
|
|
|
max |
1 |
최대 조회 수 |
|
|
|
last-page |
0..1 |
마지막 페이지 번호 |
|
|
|
record-count |
0..1 |
조회 결과 정보 건수 |
|
|
|
total-record-count |
0..1 |
조회 결과 전체 정보 건수 |
|
|
|
doi-count |
0..1 |
조회 결과 DOI 갯수 |
|
|
|
summation |
0..1 |
이용 건수 합계 |
|
|
|
records |
0..1 |
조회 결과 통계 목록 |
|
|
|
record |
0..n |
조회 결과 통계 |
|
|
|
prefix |
1 |
DOI접두사 |
|
|
|
doi |
1 |
DOI |
||
|
year |
1 |
연도 |
|
|
|
month |
월 |
1 |
연별 집계일 때는 값이 없다 |
|
|
day |
1 |
일 |
연별, 월별 집계일 때는 값이 없다 |
|
|
count |
1 |
이용 건수 |
|
|
[성공시]
[실패시]
