REST API 사용 방법

해당 제품(서비스)

LOGGER 로그인 계정이 있는 모든 사용자에게 제공합니다. 연동용 토큰은 조회 전용이며, 설정 변경은 LOGGER 콘솔에서 합니다.

REST API 정의

REST API는 개발자가 자사 시스템이나 BI 도구에서 LOGGER 리포트 데이터를 HTTP로 불러오는 방법입니다. 계약은 OpenAPI 3.1 명세로 제공하며 MCP와 같은 조회 기능, 같은 계정 권한을 사용합니다.

문서와 명세

• API 문서(Swagger): 접속한 LOGGER 서버의 /apis/docs/에서 우측 상단 Authorize에 토큰을 입력하고 Try it out으로 시험합니다.
• OpenAPI 명세: /apis/openapi.yaml(OpenAPI 3.1)입니다. ChatGPT Actions, Postman, Make 등에서 주소로 직접 가져올 수 있습니다.
• 공개 명세는 조회 계열 경로입니다. 설정 변경 경로를 포함한 전체 명세는 로그인 후 /apis/docs/full/에서 확인할 수 있습니다.

인증

1. POST /apis/v1/auth/token에 loginId, password, scope(read)를 전송하여 토큰(lgr_…)을 발급받습니다. 로그인 세션 토큰이므로 12시간 뒤 만료되며, 만료되면 다시 발급합니다.
2. 이후 모든 요청의 Authorization 헤더에 Bearer <토큰>을 입력합니다.
3. GET /apis/v1/services로 조회 가능한 서비스(loggerId) 목록을 확인합니다.

curl -X POST https://logger.co.kr/apis/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"loginId":"<로그인 ID>","password":"<비밀번호>","scope":"read"}'

curl https://logger.co.kr/apis/v1/services \
  -H "Authorization: Bearer <발급받은 토큰>"

토큰은 비밀번호와 같은 수준으로 보관하고 화면, 문서, 채팅에 노출하지 마십시오.

리포트 조회 순서

1. GET /v1/reports로 리포트 코드를 확인합니다.
2. GET /v1/reports/{code}/schema로 차원, 지표, 필터를 확인합니다(?include=values로 필터 값 형태를 확인할 수 있습니다).
3. GET /v1/reports/{code}/data로 실제 데이터를 조회합니다(loggerId, ps, pe, groupBy, filter 등).

groupBy는 한 요청에 하나만 지정합니다. 두 기준을 함께 보려면 한 기준으로 나누고 다른 기준은 filter로 좁혀 여러 번 조회합니다.

filter 값에는 화면에 표시되는 이름이 아니라 응답 rows의 value를 그대로 입력합니다.

응답과 오류

사용 절차서

조회 순서, 드릴다운, 회원 분석, 설정 변경 절차를 정리한 절차서를 API로도 받을 수 있습니다. 목록은 GET /v1/skills, 본문은 GET /v1/skills/{id}입니다. REST 인증과 응답 규약은 id가 api-guide인 절차서에 있습니다.

유의사항

• 토큰은 비밀번호와 같은 수준으로 보관하고 화면, 문서, 채팅에 노출하지 마십시오.
• 하루 호출 한도는 서비스별 1,000회(MCP와 API 합산)입니다. 한도를 초과하면 429 응답이 반환되므로 재시도하지 말고 자정 이후에 호출하십시오.