Skip to main content
GET
워크스페이스 사용량 조회

Authorizations

Authorization
string
header
required

워크스페이스 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

organization_id
string
required

조회할 워크스페이스 ID입니다(본인 또는 직속 하위 워크스페이스).

Query Parameters

start_at_after
integer | null

사용 시각 하한입니다(unix ms, 이 시각 이상). 사용 시각은 통화·테스트·채팅은 과금 기준 시각(통화 시작 시각 등)이고, 문자는 발신·수신 시각입니다. 기본값은 start_at_before 직전 시각이 속한 월의 시작 시각입니다. 정산 기간의 월 경계는 Asia/Seoul 기준입니다. 10~11자리 unix 초 입력도 허용하며 자동으로 ms로 변환됩니다.

start_at_before
integer | null

사용 시각 상한입니다(unix ms, 이 시각 미만). 기본값은 현재 시각입니다. start_at_after와의 간격은 최대 31일입니다. 통화 목록 같은 다른 목록 API의 *_before와 달리 이 시각은 포함하지 않으므로, 연속된 기간을 조회할 때는 앞 기간의 start_at_before를 다음 기간의 start_at_after로 그대로 씁니다. 10~11자리 unix 초 입력도 허용하며 자동으로 ms로 변환됩니다.

group_by
enum<string> | null

묶음 기준입니다. day는 timezone 기준 날짜별로, organization은 워크스페이스별로 나눕니다. 생략하면 기간 전체를 사용 유형별로만 묶습니다.

Available options:
day,
organization
timezone
string
default:Asia/Seoul

group_by=day의 날짜 경계에 적용할 IANA timezone입니다.

include_sub_organizations
boolean
default:false

직속 하위 워크스페이스의 사용량을 함께 집계할지 여부입니다. 상위 워크스페이스만 사용할 수 있습니다. 하위 워크스페이스 요청에서는 무시합니다.

Response

성공 응답

기간 사용량과 비용 집계입니다.

organization_id
string
required

요청한 워크스페이스 ID입니다.

start_at
integer
required

집계 기간 시작 시각입니다(unix ms, 이 시각 포함).

end_at
integer
required

집계 기간 끝 시각입니다(unix ms, 이 시각 미포함). 실제 적용된 start_at_before와 같습니다.

timezone
string
required

group_by=day의 날짜 경계에 적용한 IANA timezone 이름입니다. 예: Asia/Seoul.

group_by
enum<string> | null
required

요청한 묶음 기준입니다. 지정하지 않았으면 null입니다.

Available options:
day,
organization
total_cost
string
required

items의 cost.total_cost 합계입니다(KRW 원 단위, 문자열).

items
OrganizationUsageItemResponse · object[]
required

사용량 묶음 목록입니다. 사용량이 있는 유형만 포함됩니다.