ToAPIsToAPIs
사용량

사용량 집계 조회

일, 모델 또는 API 키 단위로 사용량 집계

GET
/api/v1/usage/summary

중국 본토 사용자 안내: 중국 본토 사용자는 https://api.toapis.cn 를 API 엔드포인트(Base URL)로 사용해 주세요. 본 문서의 예시에서 https://api.toapis.com 을 https://api.toapis.cn 로 바꿔 주세요.

인증, 페이지 처리 및 오류는 시작하기를 참조하세요.

동작

지정한 차원으로 사용량을 집계하여 일별, 모델별, 키별 소비 통계에 사용합니다. group_by가 집계 방식을 결정합니다: day는 날짜 오름차순, model은 모델 이름의 UTF-8 바이트 순 오름차순, api_key는 null 그룹을 먼저 반환한 뒤 숫자 ID 오름차순입니다.

각 집계 항목은 해당 그룹 필드만 포함합니다. from/to는 매 페이지 필수이며 범위는 최대 31일입니다.

record_count는 로그 행 수이고 unknown_phase_record_count는 청구 단계를 확인할 수 없는 행 수로, 둘 다 완전한 요청 수나 최종 순지출이 아닙니다. group_by=model 또는 api_key이면 meta.timezone=null입니다.

meta는 항상 records_mutable=true, refund_accounting=not_complete, consistency=eventual을 선언합니다: 정산과 환불은 과거 기록을 갱신하고 기록이 없다고 소비가 0은 아닙니다.

이 엔드포인트, 청구서, 요금은 각각 사용자당 분당 6회의 추가 제한이 있습니다. 서비스를 일시적으로 사용할 수 없으면 503입니다.

인증

Authorizationstring헤더필수

Bearer YOUR_SYSTEM_ACCESS_TOKEN 을 사용합니다. 모델 API 키는 사용할 수 없습니다. X-User-Id 는 필요하지 않습니다.

요청 매개변수

fromstring쿼리필수

시간대가 포함된 RFC 3339 시작 시각. 해당 시각을 포함하며 to 와 함께 지정합니다.

제약: date-time.

tostring쿼리필수

시간대가 포함된 RFC 3339 종료 시각. 해당 시각을 제외하며 from 보다 늦어야 합니다.

제약: date-time.

api_key_idstring쿼리

자신의 모델 API 키 ID 를 10 진수 문자열로 지정합니다. 타인의 키는 404 를 반환하며, 삭제된 키로도 과거 사용량을 필터링할 수 있습니다.

제약: pattern=^[1-9][0-9]*$.

modelstring쿼리

모델 식별자 정확히 일치. 사용량에서는 빈 문자열이 빈 모델 이름과 일치합니다.

제약: maxLength=255.

limitinteger쿼리기본값: 50

페이지당 최대 항목 수.

제약: minimum=1; maximum=100; 기본값: 50.

cursorstring쿼리

이전 next_cursor 를 그대로 전달하고 필터를 유지합니다. 조건을 변경하면 처음부터 조회합니다.

제약: maxLength=2048.

group_bystring쿼리기본값: day

날짜, 모델 또는 API 키별로 집계합니다.

제약: day, model, api_key; 기본값: day.

timezonestring쿼리기본값: UTC

group_by=day 에서만 지정합니다. 다른 집계는 meta.timezone=null 을 반환합니다.

제약: UTC, Asia/Shanghai; 기본값: UTC.

요청 예제

요청 예시

curl --request GET \
  --url 'https://api.toapis.com/api/v1/usage/summary?from=2026-11-01T00:00:00Z&to=2026-11-02T00:00:00Z&group_by=day&timezone=UTC' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'
import requests

response = requests.get(
    "https://api.toapis.com/api/v1/usage/summary",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    params={
        "from": "2026-11-01T00:00:00Z",
        "to": "2026-11-02T00:00:00Z",
        "group_by": "day",
        "timezone": "UTC"
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())
const url = new URL("https://api.toapis.com/api/v1/usage/summary");
url.search = new URLSearchParams({
  "from": "2026-11-01T00:00:00Z",
  "to": "2026-11-02T00:00:00Z",
  "group_by": "day",
  "timezone": "UTC"
}).toString();

const response = await fetch(url, {
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

응답 필드

예시는 가상 데이터이며 credits_per_usd="100" 을 가정합니다. 실제 환산에는 응답 값을 사용하세요.

결과는 data.items 에 있습니다. has_more 와 next_cursor 로 페이지를 조회합니다. 마지막 커서는 null 이며 총 개수는 반환하지 않습니다.

codeinteger

결과 코드. 0 은 성공입니다.

messagestring

성공 시 빈 문자열이며 오류 메시지는 현지화됩니다.

dataobject

현재 조회의 결과 객체입니다.

data.itemsobject[]

현재 페이지의 기록 목록이며 빈 결과는 [] 입니다.

data.items[].daystring

group_by=day 에서만 반환하는 날짜 그룹이며 지정한 timezone 을 따릅니다. 형식은 YYYY-MM-DD 입니다.

data.items[].modelstring

group_by=model 에서만 반환하는 모델 그룹입니다.

data.items[].api_key_idstring | null

group_by=api_key 의 키 그룹. 키 없는 소비는 null 그룹입니다.

data.items[].record_countinteger

그룹의 소비 로그 행 수이며 완전한 요청 수를 보장하지 않습니다.

data.items[].recorded_cost_usdstring

그룹의 현재 소비 로그 USD 합계이며 모든 환불을 반영한 순지출이 아닙니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다.

data.items[].recorded_creditsstring

그룹의 현재 소비 로그 credits 합계입니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다.

data.items[].input_tokensinteger

그룹 내 입력 token 합계입니다.

data.items[].output_tokensinteger

그룹 내 출력 token 합계입니다.

data.items[].unknown_phase_record_countinteger

결제 단계가 불명확한 그룹 내 로그 행 수입니다.

data.has_moreboolean

다음 페이지가 있는지 나타냅니다.

data.next_cursorstring | null

동일한 필터로 cursor 에 그대로 전달합니다. 마지막 페이지는 null 입니다.

data.metaobject

데이터 출처, 조회 범위 및 집계 기준 등의 메타데이터입니다.

data.meta.scopestring

조회 데이터의 소유 범위이며 인증된 계정 자신입니다. 고정 값: "self".

data.meta.fromstring

조회 시간 범위의 시작 시각을 포함합니다. 시간대가 포함된 RFC 3339 형식입니다.

data.meta.tostring

조회 시간 범위의 종료 시각은 제외합니다. 시간대가 포함된 RFC 3339 형식입니다.

data.meta.time_basisstring

시간 필터와 날짜 집계는 소비 로그 생성 시각을 사용합니다. 고정 값: "record_created_at".

data.meta.cost_basisstring

금액은 현재 소비 로그 값이며 고정된 최종 청구서가 아닙니다. 고정 값: "current_consume_log_amount".

data.meta.refund_accountingstring

환불 반영의 완전성입니다. not_complete 는 완전한 순지출 원장이 아님을 뜻합니다. 고정 값: "not_complete".

data.meta.records_mutableboolean

정산이나 환불로 기록이 갱신될 수 있는지 나타내며 현재 true 입니다.

data.meta.consistencystring

eventual 은 최종 일관성으로 기록이 나중에 갱신될 수 있습니다. 고정 값: "eventual".

data.meta.consume_logging_enabledboolean

소비 로그 활성화 여부입니다. 기록이 없다고 청구가 없음을 뜻하지 않습니다.

data.meta.credits_per_usdstring

1 USD 당 credits 수. 이 값으로 환산합니다. 정밀도를 유지하기 위해 십진수 문자열로 반환합니다.

data.meta.group_bystring

현재 집계의 그룹 기준입니다.

data.meta.timezonestring | null

날짜 그룹의 시간대. 모델이나 API 키별 집계에서는 null 입니다.

응답 예제

응답 예시

{
  "code": 0,
  "message": "",
  "data": {
    "items": [
      {
        "day": "2026-11-01",
        "record_count": 2,
        "recorded_cost_usd": "0.04",
        "recorded_credits": "4",
        "input_tokens": 2000,
        "output_tokens": 400,
        "unknown_phase_record_count": 0
      }
    ],
    "has_more": false,
    "next_cursor": null,
    "meta": {
      "scope": "self",
      "from": "2026-11-01T00:00:00Z",
      "to": "2026-11-02T00:00:00Z",
      "time_basis": "record_created_at",
      "cost_basis": "current_consume_log_amount",
      "refund_accounting": "not_complete",
      "records_mutable": true,
      "consistency": "eventual",
      "consume_logging_enabled": true,
      "credits_per_usd": "100",
      "group_by": "day",
      "timezone": "UTC"
    }
  }
}