콘텐츠로 이동

리포트

Prism API(포트 9003)는 반복 리포트 요청을 관리하고 worker가 생성 및 전송을 실행합니다 — 리포트가 언제 생성되고 전송될지 결정하는 스케줄과, 무엇이 전송되었는지에 대한 로그입니다. 모든 엔드포인트는 표준 gck_* / prism_* 키로 인증하며 (Authentication) 호출자 범위로 제한됩니다.

스케줄은 리포트 주기(주간, 일간, 월간)이며, 섹션 집합을 가집니다.

메서드경로용도
GET/v1/reports/schedules호출자의 스케줄 목록
POST/v1/reports/schedules스케줄 생성
POST/v1/reports/schedules/defaults기본 스케줄 집합 생성 (주간)
PATCH/v1/reports/schedules/:id스케줄 수정
DELETE/v1/reports/schedules/:id스케줄 삭제
POST/v1/reports/schedules/:id/run스케줄을 즉시 실행 (주기와 무관하게)

생성 / 수정 바디 (필드; 수정 시 모두 선택 사항):

  • frequency"weekly", "daily", "monthly".
  • sections — 포함할 리포트 섹션 (아래 섹션 기본값 참고).
메서드경로용도
GET/v1/reports/section-defaults?frequency=weekly주어진 주기의 기본 섹션 목록

{ "sections": [...] }을 반환합니다 — 해당 주기에서 기본으로 활성화되는 섹션 키입니다. 스케줄을 생성할 때 sections 필드를 초기화하는 데 사용하세요.

스케줄이 실행될 때마다(또는 온디맨드로 실행될 때마다) 전송을 기록합니다.

메서드경로용도
GET/v1/reports/deliveries호출자의 최근 전송 목록
GET/v1/reports/deliveries/:id단일 전송 조회