AbleFlowDocs

진단 결과

리포트 데이터(뷰어용 JSON, 한 번에 그리는 묶음). PDF 도 같은 데이터로 프론트 인쇄 페이지를 그린다.

GET/api/diagnoses/{diagnosisId}/report

끝난(COMPLETED · PARTIAL) 회차만. 구성원 누구나

  • Scoperesults:read
  • Since1.0.0
  • Success200
  • Demo tokenAllowed
  • Personal dataThe response contains personal data

id diagnoses.report

Path parameters

GetReportRequestPath

  • diagnosisIdstringrequired

Query

쿼리의 배열은 콤마로 이어 보낸다(status=A,B)

GetReportRequestParams

  • tierAbleflowReportTieroptional
    • SUMMARY
    • FULL

    기본 SUMMARY. FULL 은 요금제로 막을 때 전체 리포트가 있는 요금제 · 건당 구매한 회차만(막지 않으면 누구나)

Response 200

GetReportResponse

  • tierAbleflowReportTierrequired
    • SUMMARY
    • FULL

    Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

    AbleFlow - 리포트 등급. SUMMARY 는 화면마다 위험 구간 3개 · 개선 우선순위 5개, FULL 은 전부(요금제는 P2)

  • objectrequired

    표지

    • idstringrequired
    • namestringrequired
    • baseUrlstringoptional
  • workspaceNamestringrequired
  • objectrequired
    • idstringrequired
    • seqnumberrequired
    • finishedAtstringrequired
    • AbleflowMemberRefrequired

      AbleFlow - 사람 표시. 이름 · 이메일은 계정 DB 에서 채운다(찾지 못하면 name 없음). 공개 API 토큰에 members:read 가 없으면 email 이 빠진다

    • criteriaAbleflowCriterion[]required

      AbleFlow - 진단 기준

    • viewportsAbleflowViewport[]required

      AbleFlow - 분석 뷰포트(진단 기본값). 화면은 BOTH 까지

    • scoringVersionstringrequired
  • AbleflowScoreSetrequired

    요약 · 기준별(GET /api/diagnoses/{id} 의 scores 와 같다)

    • uxRiskScorenumberrequired
    • cognitionScorenumberrequired
    • gradeAbleflowGraderequired
      • SAFE
      • CAUTION
      • RISK
      • CRITICAL

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 대표 위험도 구간: 0~29 SAFE · 30~49 CAUTION · 50~69 RISK · 70~100 CRITICAL

    • object[]required
  • objectoptional

    바로 앞 끝난 회차(없으면 없음)

    • seqnumberrequired
    • AbleflowScoreSetrequired

      AbleFlow - 점수 묶음. 위험도 0~100(높을수록 위험) · 이해도 = 100 - 위험도. criteria 는 평가한 기준만(AI 판단이 꺼져 있거나 답을 받지 못한 기준은 빠진다)

  • findingCountnumberrequired

    회차 전체 위험 구간 수(tier 와 상관없이)

  • object[]required

    화면별(프로젝트 화면 순서 → 뷰포트). 화면별 결과 API 와 같은 값

    • screenResultIdstringrequired
    • screenNamestringrequired
    • urlstringoptional
    • viewportAbleflowViewportrequired
      • PC
      • MOBILE

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 분석 뷰포트(진단 기본값). 화면은 BOTH 까지

    • analysisPrecisionAbleflowAnalysisPrecisionrequired
      • DOM
      • PIXEL

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 분석 정확도: URL · 확장 프로그램은 요소 정보(DOM), 이미지는 픽셀(PIXEL)

    • FileInfoResponseoptional

      이미지 화면은 없음(화면에 올린 이미지를 쓴다)

    • AbleflowScoreSetoptional

      COMPLETED 만

    • object[]required

      FULL 은 전부, SUMMARY 는 위에서 3개(심각도 → 만든 순). 영역이 없는 위험 구간은 region 이 없다

    • failureReasonAbleflowFailureReasonoptional
      • NOT_FOUND
      • TIMEOUT
      • LOGIN_REQUIRED
      • BLOCKED
      • UNKNOWN

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 분석 실패 이유

  • GetPrioritiesResponseItem[]required

    개선 우선순위(SUMMARY 는 위에서 5개). GET /api/diagnoses/{id}/priorities/list 와 같은 모양 · 순위

    • ranknumberrequired

      1부터(회차 전체 기준. labelIds 로 걸러도 순위는 그대로)

    • groupKeystringrequired

      묶음 키 = SHA-256(기준 | 요소 단서). 화면 · 뷰포트를 넣지 않아 여러 화면의 같은 문제가 한 줄이 되고, 회차가 바뀌어도 같은 문제면 같다

    • titlestringrequired

      묶음에서 가장 심각한 위험 구간의 제목

    • titleKeystringoptional

      규칙 위험 구간에서 온 제목의 문구 키(키 목록은 AbleflowFindingMessageArgs 설명). AI 판단 제목 · 키가 없는 옛 행은 빠진다 — 그때는 title 을 그대로 보인다

    • AbleflowFindingMessageArgsoptional

      문구 키의 이름 붙은 값(값 자리가 없는 문구 · 키가 없으면 빠진다)

    • criterionAbleflowCriterionrequired
      • COLOR_DEPENDENCY
      • LOW_CONTRAST
      • INFORMATION_DENSITY
      • LAYOUT_COMPLEXITY
      • STATUS_COMMUNICATION

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 진단 기준

    • severityAbleflowSeverityrequired
      • HIGH
      • MEDIUM
      • LOW

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      묶은 위험 구간 중 가장 높은 것

    • impactnumberrequired

      0~100 = round(영향 분석 위험도 합 ÷ (100 × 회차 분석 수) × 100)

    • findingIdsstring[]required
    • elementHintstringoptional

      대표 위험 구간(심각도 높은 순 → 먼저 생긴 순)의 요소 단서. 화면이 같은 제목 · 같은 값 줄을 묶어 펼칠 때 요소 이름으로 보인다. 없으면 빠진다

    • elementHintKeystringoptional

      elementHint 가 규칙의 고정 단서일 때 표시용 키(예: firstScreen). 셀렉터 · AI 단서는 빠진다

    • object[]required

      영향 화면(화면 순서 · 뷰포트 순)

    • effortAbleflowEffortoptional
      • EASY
      • MEDIUM
      • HARD

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      아래 넷은 기준별 고치는 방법(운영 콘솔 고정표)에서 읽는다. 고정표가 없으면 빠진다

    • componentAbleflowGuideComponentoptional
      • ERROR_MESSAGE
      • BUTTON
      • INPUT
      • CARD_TABLE
      • TEXT
      • TAB_STATUS

      Newer versions may send values you don't know. Handle unknown values safely (for example as 'other').

      AbleFlow - 고칠 부품 종류(오류 메시지 · 버튼 · 입력 칸 · 카드, 표 · 글 영역 · 탭, 상태 표시)

    • evidencestringoptional

      근거 한 줄 · 고치는 방법

    • fixstringoptional
    • objectoptional

      이미 담은 열린(DONE · DISMISSED 가 아닌) 과제

    • AbleflowGuideoptional

      전문가 고정표(expert)와 AI 제안(ai, 묶음의 대표 위험 구간에 AI 제안이 있을 때만)을 나눠 준다

  • objectrequired

    부록: 기준 설명(운영 콘솔 기준별 고치는 방법의 근거 한 줄, 고정표가 없는 기준은 description 이 없다) · 산식 버전

    • scoringVersionstringrequired
    • object[]required

Errors

Errors of this endpoint
StatusCodeWhen
409DIAGNOSIS_NOT_FINISHED끝나지 않은 회차
403PLAN_FEATURE_REQUIREDtier=FULL 인데 요금제에 전체 리포트가 없거나 체험이 끝났다(요금제로 막을 때, 건당 구매한 회차는 열린다). detail { target: REPORT_FULL, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? }
9 errors common to every public API
Common to every public API
StatusCodeWhen
400UNSUPPORTED_API_VERSIONAbleFlow-Version(또는 토큰 고정 버전)을 맞출 수 없다. detail { requested, supported }
401UNAUTHORIZEDAuthorization 머리글이 없다(토큰 없음). 공개 API 요청으로 보지 않아 응답에 AbleFlow-Version 머리글이 없다
401INVALID_TOKEN토큰이 틀렸거나 폐기됐다(발급자가 워크스페이스를 나가 폐기된 토큰 포함)
401TOKEN_EXPIRED토큰이 만료됐다
403INSUFFICIENT_SCOPE토큰 범위가 모자란다. detail { required }
403DEMO_READ_ONLY데모 토큰은 GET · HEAD 만 부를 수 있다
403PLAN_FEATURE_REQUIRED워크스페이스 요금제에 공개 API 가 없거나 체험이 끝났다(요금제로 막을 때, 데모 토큰 제외). detail { target: PUBLIC_API, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? }
404RESOURCE_NOT_FOUND자원이 없거나 토큰이 묶인 워크스페이스 밖이다
429API_RATE_LIMITED호출 한도를 넘었다. Retry-After(초)