API 레퍼런스
로그인
본문으로 건너뛰기

대시보드

GET/v1/dashboard

콘솔 대시보드 요약, 크레딧, 이번 달 지출, 7일 실행 분, 준비 시간, 러너 카드를 돌려줍니다

API 키 권한 read 또는 콘솔 세션으로 부릅니다, 콘솔 세션은 조직 역할 owner, admin, developer만 됩니다

참고 서버 구현(2026-10-12 dev 기준)이 계약 초안과 다른 점

  • workspace_id와 api_key_id 쿼리는 무시합니다

Headers

  • Authorization: optional string
    Bearer xci_live_… 워크스페이스 API 키, 키 권한 read(run 키도 가능), 콘솔 세션 쿠키로 대신할 수 있습니다

Query Parameters

  • org_id: optional string
    콘솔 세션은 필수, API 키는 무시(키의 조직)

Returns

200 application/json

  • Dashboard: object
    • organization_id: string
      조직 ID
    • credit: object { balance_micro_usd, balance_usd, available_micro_usd, … }
      잔액과 사용 가능 잔액
      • balance_micro_usd: optional integer
        금액(µUSD 정수)
        최소 0
      • balance_usd: optional string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
      • available_micro_usd: optional integer
        금액(µUSD 정수)
        최소 0
      • available_usd: optional string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
    • month_spend_micro_usd: integer
      이번 달(UTC) 정산액, 호출 범위 기준
      최소 0
    • month_spend_usd: string
      이번 달 지출(USD)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • run_minutes_7d: object { total_minutes, jobs, days }
      최근 7일 과금 분과 잡 수, 날짜별
      • total_minutes: optional integer
        분 합계
      • jobs: optional integer
        잡 수
      • days: optional array of object { date, billed_minutes, jobs }
        날짜별
        • date: optional string
          UTC 날짜
        • billed_minutes: optional integer
          그날 과금된 분
        • jobs: optional integer
          그날 잡 수
    • prepare_7d: object { vm_prepare }
      최근 7일 VM 준비 시간
      • vm_prepare: optional PhaseStat { samples, avg_seconds, p95_seconds }
        VM 준비
        • samples: integer
          집계에 쓴 잡 수
          최소 0
        • avg_seconds: number or null
          평균 초(소수 1자리), 표본이 없으면 null
        • p95_seconds: number or null
          최근접 순위 95번째 백분위 초, 표본이 없으면 null
    • runners: array of RunnerCard { id, title, subtitle, … }
      러너 카드
      • id: "macos-m4" or "xcode-latest" or "xcode-previous" or "simulator-runtimes"
        ID
      • title: string
        제목
      • subtitle: optional string or null
        부제
      • xcode: optional string or null
        Xcode 버전
      • runtimes: optional array of string
        런타임
      • status: "available" or "busy" or "unavailable"
        러너 상태
    • tier: optional integer
      티어 요약

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • api_key_required: HTTP 401
    API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다
  • api_key_revoked_leaked: HTTP 401
    공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요
  • invalid_api_key: HTTP 401
    모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • ip_not_allowed: HTTP 403
    요청 IP가 조직 또는 API 키의 IP 허용 목록 밖입니다, details.ip와 details.list(organization 또는 api_key)에 있습니다
  • organization_suspended: HTTP 403
    운영자가 조직을 정지했습니다, 키는 거부되고 실행 중인 잡은 멈춥니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다