> ## Documentation Index > Fetch the complete documentation index at: https://docs.meterengine.com/llms.txt > Use this file to discover all available pages before exploring further. # 사용량 이벤트 조회 > 지정한 달의 이벤트를 occurred_at 최신순으로 한 페이지씩 돌려준다. occurred_at이 같으면 transaction_id 내림차순이다. 기간은 KST 기준의 달이다. occurred_at 2026-08-31T23:59:59+09:00 이벤트는 8월에, 2026-09-01T00:00:00+09:00 이벤트는 9월에 든다. 사용량 조회와 기준이 같다. customer_id, month, type을 함께 주면 모두 만족하는 이벤트만 나오고, total은 조건을 적용한 뒤의 건수다. from과 to를 함께 주면 월 대신 자유 기간을 조회한다. 시작은 포함하고 종료 시각은 제외한다. 날짜만 준 to는 그 날짜의 하루 전체를 포함한다. 시간대 없는 날짜와 시각은 KST다. q는 transaction_id, 고객 이름과 외부 ID의 부분 검색이다. properties는 JSON 객체의 값이 포함된 이벤트를 찾는다. from과 to는 함께 주어야 하고 month와 같이 쓸 수 없다. 인보이스 검색은 한쪽만 주거나 month와 함께 줄 수 있어 규칙이 다르다. 모르는 조회 조건은 무시한다. 내보내기, 월 목록, 이벤트 문제와 수집 거절 검색은 모르는 조회 조건을 400으로 거절한다. properties는 저장된 값 그대로다. 키 순서와 공백은 보낸 것과 다를 수 있고, 숫자 자릿수는 그대로다. ## OpenAPI ````yaml https://raw.githubusercontent.com/asm17-ms2/meterengine/main/backend/openapi.yaml get /v1/events openapi: 3.1.0 info: description: | 사용량 기반 과금 플랫폼의 API. 사용량 이벤트를 수집하고, 고객별 월 사용량과 청구 예정액을 조회한다. 요청마다 Authorization 헤더에 Bearer 값으로 API 키(me_live_ 또는 me_test_로 시작)나 로그인 세션 토큰을 싣는다. 도입사는 키나 세션이 정한다. 헤더가 없으면 401이다. X-MeterEngine-Environment: test 또는 live로 업무 환경을 지정한다. 새 키는 발급 환경에 고정된다. 기존 데이터와 키는 환경 미지정 범위로 보존하며 자동으로 test/live에 배정하지 않는다. 환경 분리가 지원되지 않는 업무는 명시 환경 요청에 409를 반환한다. X-MeterEngine-Organization-Id: 화면의 도입사를 고정하는 선택 UUID 헤더다. 인증된 도입사와 다르면 403이며 이 헤더로 인증이나 도입사 전환을 대신할 수 없다. 오류 응답은 code, message, errors로 이뤄진다. 오류별 처리는 code로 분기한다. message는 code마다 하나인 한국어 문구이고, errors는 틀린 필드를 짚을 수 있는 400에만 실린다. title: MeterEngine API version: v1 servers: - description: MeterEngine API url: https://meterengine.com security: - bearerAuth: [] tags: - name: organization-environment-controller x-group: 업무 환경 - name: current-organization-controller x-group: 도입사 정보 - name: api-key-controller x-group: API 키 (콘솔 전용) - name: organization-people-controller x-group: 구성원과 초대 (콘솔 전용) - name: audit-log-controller x-group: 감사 기록 (콘솔 전용) - name: billable-metric-controller x-group: 미터 - name: billable-metric-price-controller x-group: 미터별 단가 조회 - name: price-rate-controller x-group: 단가 - name: price-plan-controller x-group: 요금제 - name: customer-controller x-group: 고객 - name: event-controller x-group: 이벤트 - name: event-batch-controller x-group: 이벤트 일괄 전송 - name: event-export-controller x-group: 이벤트 내보내기 - name: billable-metric-usage-controller x-group: 사용량 집계 - name: event-issue-controller x-group: 이벤트 매핑 진단 - name: event-rejection-controller x-group: 수집 거절 - name: unbilled-event-controller x-group: 청구 제외 사용량 - name: dashboard-controller x-group: 개요 - name: workspace-query-controller x-group: 검색과 내보내기 - name: draft-invoice-controller x-group: 청구 예정액 - name: invoice-controller x-group: 인보이스 - name: invoice-view-link-controller x-group: 인보이스 조회 링크 - name: payment-setting-controller x-group: 결제 설정 - name: toss-payments-credential-controller x-group: 토스페이먼츠 키 - name: payment-method-registration-controller x-group: 카드 등록 링크 - name: payment-method-controller x-group: 결제 수단 - name: payment-attempt-controller x-group: 결제 요청 - name: invoice-payment-controller x-group: 수납 상태 - name: payment-cancellation-controller x-group: 결제 취소 - name: payment-reconciliation-mismatch-controller x-group: 대사 불일치 - name: toss-payments-webhook-controller x-group: 토스페이먼츠 웹훅 수신 - name: webhook-endpoint-controller x-group: 웹훅 paths: /v1/events: get: tags: - event-controller summary: 사용량 이벤트 조회 description: > 지정한 달의 이벤트를 occurred_at 최신순으로 한 페이지씩 돌려준다. occurred_at이 같으면 transaction_id 내림차순이다. 기간은 KST 기준의 달이다. occurred_at 2026-08-31T23:59:59+09:00 이벤트는 8월에, 2026-09-01T00:00:00+09:00 이벤트는 9월에 든다. 사용량 조회와 기준이 같다. customer_id, month, type을 함께 주면 모두 만족하는 이벤트만 나오고, total은 조건을 적용한 뒤의 건수다. from과 to를 함께 주면 월 대신 자유 기간을 조회한다. 시작은 포함하고 종료 시각은 제외한다. 날짜만 준 to는 그 날짜의 하루 전체를 포함한다. 시간대 없는 날짜와 시각은 KST다. q는 transaction_id, 고객 이름과 외부 ID의 부분 검색이다. properties는 JSON 객체의 값이 포함된 이벤트를 찾는다. from과 to는 함께 주어야 하고 month와 같이 쓸 수 없다. 인보이스 검색은 한쪽만 주거나 month와 함께 줄 수 있어 규칙이 다르다. 모르는 조회 조건은 무시한다. 내보내기, 월 목록, 이벤트 문제와 수집 거절 검색은 모르는 조회 조건을 400으로 거절한다. properties는 저장된 값 그대로다. 키 순서와 공백은 보낸 것과 다를 수 있고, 숫자 자릿수는 그대로다. operationId: listEvents parameters: - description: 0부터 세는 페이지 번호. in: query name: page required: false schema: type: integer format: int32 default: 0 minimum: 0 - description: 한 페이지에 담을 개수. in: query name: size required: false schema: type: integer format: int32 default: 20 maximum: 100 minimum: 1 - description: 고객을 좁힌다. 생략하면 모든 고객이 대상이다. in: query name: customer_id required: false schema: type: string format: uuid - description: 조회할 달(yyyy-MM, KST). 생략하면 이번 달이다. example: 2026-08 in: query name: month required: false schema: type: string - description: 이벤트 type을 좁힌다. 어느 미터의 event_type도 아닌 값이어도 저장된 이벤트는 조회된다. in: query name: type required: false schema: type: string - in: query name: from required: false schema: type: string maxLength: 64 minLength: 0 - in: query name: to required: false schema: type: string maxLength: 64 minLength: 0 - in: query name: q required: false schema: type: string maxLength: 512 minLength: 0 - in: query name: sort required: false schema: type: string maxLength: 40 minLength: 0 - in: query name: order required: false schema: type: string maxLength: 4 minLength: 0 - in: query name: properties required: false schema: type: string maxLength: 4096 minLength: 0 responses: '200': content: '*/*': schema: $ref: '#/components/schemas/ListEventsResponse' description: 한 페이지 분량의 이벤트. 조건에 맞는 것이 없으면 events가 빈 배열이다 '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > code=validation_error: page가 음수거나 size가 1~100 밖이거나, customer_id가 UUID가 아니거나 month가 yyyy-MM이 아니거나 0001-01부터 9999-12까지의 범위 밖이거나, type에 NUL 문자나 짝이 없는 UTF-16 서로게이트가 있다. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: | code=authentication_required: Authorization 헤더가 없다. code=invalid_credentials: 키나 토큰의 형식이 틀렸거나, 모르는 값이거나, 폐기 또는 만료됐다. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: > code=permission_denied: 키의 스코프나 계정의 역할로는 할 수 없는 요청이거나, 도입사가 정해지지 않은 로그인 세션이다. code=organization_not_active: 도입사가 활성 상태가 아니다. code=consent_required: 로그인 세션의 사용자가 필수 안내에 아직 동의하지 않았다. POST /v1/sessions/current/consents로 동의한다. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'code=customer_not_found: customer_id가 가리키는 고객이 없다' '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- code=rate_limit_exceeded: 키의 분당 요청 한도를 넘었다. Retry-After 헤더의 초만큼 기다린 뒤 다시 보낸다. headers: Retry-After: description: 다시 보내기 전에 기다릴 초 required: true schema: type: integer format: int32 components: schemas: ListEventsResponse: type: object properties: events: type: array items: $ref: '#/components/schemas/EventResponse' from: type: string format: date-time month: type: string page: type: integer format: int32 size: type: integer format: int32 to: type: string format: date-time total: type: integer format: int64 ErrorResponse: type: object description: 오류 응답. code로 오류 종류를 구분하고, message는 code마다 하나인 한국어 문구다. properties: code: type: string description: 오류 종류. 오류별 처리는 이 값으로 분기한다. enum: - validation_error - malformed_request_body - invalid_billable_metric - invalid_price_rate - event_too_old - invalid_toss_payments_credential - payment_method_rejected - toss_payments_test_code_in_live_mode - invalid_webhook_url - invalid_webhook_event_type - authentication_required - invalid_credentials - permission_denied - organization_not_active - environment_mismatch - consent_required - customer_not_found - event_not_found - billable_metric_not_found - price_rate_not_found - invoice_not_found - invoice_view_link_not_found - endpoint_not_found - api_key_not_found - organization_not_found - user_account_not_found - payment_method_not_found - payment_method_registration_not_found - payment_attempt_not_found - toss_payments_credential_not_found - price_plan_not_found - webhook_endpoint_not_found - webhook_delivery_not_found - invitation_not_found - method_not_allowed - response_type_not_acceptable - resource_version_conflict - idempotency_conflict - customer_archived - resource_archived - environment_not_ready - archive_restoration_conflict - customer_has_events - customer_has_payment_attempts - billable_metric_has_events - billable_metric_has_price_rate - billable_metric_already_exists - billable_metric_event_type_target_property_already_exists - invoice_already_paid - payment_result_unconfirmed - payment_retry_unavailable - payment_retry_stale - invoice_amount_zero - email_already_exists - organization_status_transition_invalid - organization_member_already_exists - toss_payments_credential_missing - payment_method_missing - payment_mode_mismatch - payment_attempt_not_cancelable - payment_attempt_fully_canceled - payment_cancellation_amount_exceeded - payment_cancellation_in_progress - payment_cancellation_idempotency_conflict - webhook_delivery_not_retryable - price_rate_history_immutable - price_plan_history_immutable - webhook_endpoint_disabled - webhook_endpoint_limit_exceeded - invitation_unavailable - last_owner_required - owner_scopes_required - last_operator_required - api_key_unavailable - upload_size_exceeded - request_type_not_supported - rate_limit_exceeded - internal_server_error - request_timed_out - toss_payments_unavailable errors: type: array description: 틀린 필드 목록. 400 응답에만 실린다. items: $ref: '#/components/schemas/FieldError' message: type: string description: code마다 하나인 한국어 문구. 예고 없이 바뀔 수 있으니 분기에 쓰지 않는다. example: 서버 내부 오류입니다 required: - code - message EventResponse: type: object properties: actor_id: type: string format: uuid actor_type: type: string customer_id: type: string format: uuid customer_name: type: string occurred_at: type: string format: date-time properties: type: object additionalProperties: {} received_at: type: string format: date-time request_id: type: string format: uuid description: 최초 저장 요청의 감사 ID. 기존 원본에는 없다 transaction_id: type: string type: type: string FieldError: type: object description: 틀린 필드 하나 properties: field: type: string description: 틀린 값을 보낸 자리의 이름. 요청에 쓴 이름과 같다. example: event_type message: type: string description: 이 자리의 값이 거절된 이유. example: 공백일 수 없습니다 securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.