> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trychainshift.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 구글 키워드 지표

> > **[BETA]** 베타 API 입니다. 응답 스펙이 예고 없이 변경될 수 있습니다.

키워드 목록(최대 100개)의 구글 검색 지표(월평균 검색량·SEO 난이도·CPC·검색 의도·검색량 추이)를 조회합니다. 데이터가 없는 키워드는 metrics가 null이며, metrics는 있으나 searchVolume이 null이면 검색량이 비공개된 키워드입니다.

### 오류

| HTTP | 코드 | 설명 |
| --- | --- | --- |
| 400 | `COMMON_BINDING` | 요청 본문 JSON 파싱 실패 |
| 400 | `COMMON_VALIDATION` | 키워드 1~100개·중복 불가·각 80자 이내 위반 |
| 400 | `KEYWORD_COUNTRY_NOT_SUPPORTED` | 지원하지 않는 국가 코드 |
| 400 | `KEYWORD_METRICS_PROVIDER_REJECTED` | 공급자가 요청을 거부 (언어·국가 조합, 키워드 형식) |
| 401 | `COMMON_UNAUTHORIZED` | API 키 또는 액세스 토큰이 없거나 유효하지 않음 |
| 402 | `INSUFFICIENT_CREDITS` | 조직 크레딧 잔액이 이 요청의 단가보다 적음 |
| 429 | `PLATFORM_RATE_LIMIT_EXCEEDED` | 요청 한도 초과. `Retry-After` 헤더의 초만큼 기다린 뒤 재시도 |
| 500 | — | 서버 내부 오류. `code` 없이 `message` 와 `requestID` 를 반환 |
| 502 | `KEYWORD_METRICS_PROVIDER_UNAVAILABLE` | 지표 공급자 호출 실패. 잠시 후 재시도 |
| 503 | `KEYWORD_METRICS_NOT_CONFIGURED` | 키워드 지표 기능이 활성화되지 않음 |



## OpenAPI

````yaml POST /v1beta/platform/keywords/google/metrics
openapi: 3.1.0
info:
  description: >-
    외부 파트너용 플랫폼 API. 조직 API 키 기반 인증을 사용합니다.

    ### 공통 요청 제한

    - 요청 body 크기는 최대 2MiB이며, 초과 시 413과 함께 `COMMON_REQUEST_BODY_TOO_LARGE` 코드를
    반환합니다.

    - 배열 파라미터와 문자열 필드에는 엔드포인트별 개수·길이 상한이 있습니다. 상한은 각 필드/파라미터 설명에 명시되어 있으며, 위반 시
    400과 함께 `COMMON_VALIDATION` 코드를 반환합니다.

    ### 오류 응답

    오류 응답 본문은 상태 코드와 상관없이 항상 같은 세 필드입니다.

    | 필드 | 형태 | 의미 |

    | --- | --- | --- |

    | `code` | 문자열 | 오류 종류를 가리키는 고정 식별자입니다. 클라이언트가 분기할 대상은 이 값 하나입니다. 엔드포인트가
    반환하는 코드 목록은 각 API 의 "오류" 표에 있습니다. |

    | `message` | 문자열 | 오류 전체를 한 줄로 요약한, 사람이 읽는 문장입니다. 언제나 한 개입니다. |

    | `details` | 문자열 배열 | `message` 한 줄로는 부족한 개별 사유입니다. 사유가 한 건이어도 길이 1 배열로
    내려가며, 담을 사유가 없으면 필드 자체가 빠집니다. |

    - `details` 는 어떤 오류에서도 배열입니다. 문자열이나 객체로 내려오는 경우는 없으므로 형태별 분기가 필요 없습니다.

    - `details` 의 문구 자체는 고정 계약이 아닙니다. 화면 표시와 디버깅에만 쓰고, 문자열을 파싱해 분기하지 마십시오. 분기는
    `code` 로 하십시오.

    - 여러 건의 사유를 담는 필드는 `details` 하나뿐입니다. `messages` 라는 필드는 응답에 존재하지 않습니다.

    - 검증 실패(`COMMON_VALIDATION`) 시 `details` 에는 위반 필드마다 `"필드: 사유"` 한 줄씩 담깁니다. 예:
    `{"code":"COMMON_VALIDATION","message":"데이터 검증에
    실패했습니다","details":["keywords: 최대 100개까지 입력할 수 있습니다"]}`

    - `message` 는 기본이 한국어이고, `Accept-Language: en` 을 보내면 영어로 제공됩니다. `details` 도
    검증 실패처럼 필드별 사유를 담는 경우에는 같은 규칙을 따르지만, 진단 목적으로 원문을 그대로 싣는 오류에서는 요청 언어와 다른 문구가
    담길 수 있습니다.

    - 500 만 형태가 다릅니다. `code` 없이 `message` 와, 문의 시 참조할 `requestID` 를 반환합니다.
  title: Platform API
  version: '1.0'
servers:
  - url: https://platform-api.trychainshift.ai/api
security: []
tags:
  - description: API 키가 귀속되는 최상위 계정 단위입니다. 조직의 기본 정보를 조회합니다.
    name: Organization
  - description: AI 서비스에서 노출을 모니터링하는 대상 브랜드입니다. 브랜드 등록·조회·수정·삭제를 제공합니다.
    name: Brand
  - description: >-
      브랜드와 시장을 분석하기 위한 키워드 인텔리전스입니다. 구글·네이버 검색 지표, 연관·자동완성 키워드 조회와 사이트 URL 기반
      키워드 분석을 제공합니다.
    name: Keyword (Beta)
  - description: 프롬프트를 목적별로 묶는 그룹입니다. 프롬프트 세트 생성·조회·수정·삭제를 제공합니다.
    name: PromptSet
  - description: AI 서비스에 질의하는 문장 단위입니다. 프롬프트 생성·조회·수정·삭제와 대량 생성을 제공합니다.
    name: Prompt
  - description: 프롬프트 실행에 사용하는 AI 서비스 모델입니다. 지원 모델 목록을 조회합니다.
    name: Model
  - description: 프롬프트 실행에 사용하는 실행 지역입니다. 지원 리전 목록을 조회합니다.
    name: Region
  - description: 프롬프트를 AI 서비스에 실제로 실행하는 작업 단위입니다. 프롬프트 실행 요청과 진행 상태·목록 조회를 제공합니다.
    name: Run
  - description: 실행으로 수집된 AI 서비스의 응답입니다. 인용 출처·검색 쿼리를 포함한 답변을 조회합니다.
    name: Answer
  - description: 답변에 인용된 출처의 도메인·URL 단위 통계 지표입니다. 인용 요약, 도메인별·URL별 인용 통계를 조회합니다.
    name: SourceStatistics (Beta)
  - description: 답변 본문의 토큰(Kiwi 명사) 통계 지표입니다. 많이 나온 토큰 랭킹과 특정 단어의 근접 토큰을 조회합니다.
    name: AnswerStatistics (Beta)
  - description: AI가 답변 생성 시 실제로 던진 검색 쿼리(팬아웃) 통계 지표입니다. 검색 쿼리별 등장 횟수 랭킹을 조회합니다.
    name: FanoutStatistics (Beta)
  - description: 텍스트에서 고유명사를 식별하는 부가 기능입니다. 고유명사 추출을 제공합니다.
    name: ProperNoun (Beta)
  - description: 조직 크레딧 잔액 및 플랫폼 API 과금 정보입니다. 현재 크레딧 잔액을 조회합니다.
    name: Credit
externalDocs:
  description: ''
  url: ''
paths:
  /v1beta/platform/keywords/google/metrics:
    post:
      tags:
        - Keyword (Beta)
      summary: 구글 키워드 지표 조회
      description: >-
        > **[BETA]** 베타 API 입니다. 응답 스펙이 예고 없이 변경될 수 있습니다.


        키워드 목록(최대 100개)의 구글 검색 지표(월평균 검색량·SEO 난이도·CPC·검색 의도·검색량 추이)를 조회합니다. 데이터가
        없는 키워드는 metrics가 null이며, metrics는 있으나 searchVolume이 null이면 검색량이 비공개된
        키워드입니다.


        ### 오류


        | HTTP | 코드 | 설명 |

        | --- | --- | --- |

        | 400 | `COMMON_BINDING` | 요청 본문 JSON 파싱 실패 |

        | 400 | `COMMON_VALIDATION` | 키워드 1~100개·중복 불가·각 80자 이내 위반 |

        | 400 | `KEYWORD_COUNTRY_NOT_SUPPORTED` | 지원하지 않는 국가 코드 |

        | 400 | `KEYWORD_METRICS_PROVIDER_REJECTED` | 공급자가 요청을 거부 (언어·국가 조합, 키워드
        형식) |

        | 401 | `COMMON_UNAUTHORIZED` | API 키 또는 액세스 토큰이 없거나 유효하지 않음 |

        | 402 | `INSUFFICIENT_CREDITS` | 조직 크레딧 잔액이 이 요청의 단가보다 적음 |

        | 429 | `PLATFORM_RATE_LIMIT_EXCEEDED` | 요청 한도 초과. `Retry-After` 헤더의 초만큼
        기다린 뒤 재시도 |

        | 500 | — | 서버 내부 오류. `code` 없이 `message` 와 `requestID` 를 반환 |

        | 502 | `KEYWORD_METRICS_PROVIDER_UNAVAILABLE` | 지표 공급자 호출 실패. 잠시 후 재시도
        |

        | 503 | `KEYWORD_METRICS_NOT_CONFIGURED` | 키워드 지표 기능이 활성화되지 않음 |
      operationId: getGoogleKeywordMetrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/domain.GetGoogleKeywordMetricsRequest'
        description: 키워드 지표 조회 요청
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.GetGoogleKeywordMetricsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.ValidationError'
          description: 키워드 1~100개·중복 불가·각 80자 이내 위반. 국가 코드·공급자 거부는 위 오류 표 참고
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.UnauthorizedError'
          description: API 키 또는 액세스 토큰이 없거나 유효하지 않습니다
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.InsufficientCreditsError'
          description: 조직 크레딧 잔액이 이 요청의 단가보다 적습니다
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.RateLimitExceededError'
          description: 요청 한도를 초과했습니다. Retry-After 헤더의 초만큼 기다린 뒤 재시도하세요
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.InternalServerError'
          description: 서버 내부 오류. requestID 를 함께 알려주시면 추적할 수 있습니다
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.KeywordProviderUnavailableError'
          description: 지표 공급자 호출에 실패했습니다. 잠시 후 재시도하세요
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.KeywordMetricsNotConfiguredError'
          description: 키워드 지표 기능이 활성화되어 있지 않습니다
      security:
        - OrgAPIKeyAuth: []
components:
  schemas:
    domain.GetGoogleKeywordMetricsRequest:
      properties:
        countryCode:
          description: 국가 코드 (ISO 3166-1 alpha-2, 기본 "KR")
          example: US
          type: string
        keywords:
          description: 조회할 키워드 목록 (1~100개, 중복 불가(대소문자·공백 표기 무시), 각 80자 이내)
          example:
            - protein powder
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
          uniqueItems: true
        languageCode:
          description: 언어 코드 (ISO 639-1, 기본 "ko")
          example: en
          type: string
      required:
        - keywords
      type: object
    domain.GetGoogleKeywordMetricsResponse:
      properties:
        countryCode:
          description: 적용된 국가 코드 (기본값 반영)
          example: US
          type: string
        items:
          description: 키워드별 지표 (요청 keywords 순서 유지)
          items:
            $ref: '#/components/schemas/domain.GoogleKeywordMetricsItemDTO'
          type: array
          uniqueItems: false
        languageCode:
          description: 적용된 언어 코드 (기본값 반영)
          example: en
          type: string
      required:
        - countryCode
        - items
        - languageCode
      type: object
    domain.ValidationError:
      properties:
        code:
          description: 오류 코드
          example: COMMON_VALIDATION
          type: string
        details:
          description: '위반한 필드별 사유 목록 ("필드: 사유" 한 줄씩)'
          example:
            - 'limit: 100 이하여야 합니다'
          items:
            type: string
          type: array
          uniqueItems: false
        message:
          description: '오류 메시지 (기본 한국어, Accept-Language: en 지정 시 영어)'
          example: 데이터 검증에 실패했습니다
          type: string
      type: object
    domain.UnauthorizedError:
      properties:
        code:
          description: 오류 코드
          example: COMMON_UNAUTHORIZED
          type: string
        message:
          description: '오류 메시지 (기본 한국어, Accept-Language: en 지정 시 영어)'
          example: 인증되지 않은 사용자입니다
          type: string
      type: object
    domain.InsufficientCreditsError:
      properties:
        code:
          description: 오류 코드
          example: INSUFFICIENT_CREDITS
          type: string
        message:
          description: '오류 메시지 (기본 한국어, Accept-Language: en 지정 시 영어)'
          example: 크레딧이 부족합니다.
          type: string
      type: object
    domain.RateLimitExceededError:
      properties:
        code:
          description: 오류 코드
          example: PLATFORM_RATE_LIMIT_EXCEEDED
          type: string
        message:
          description: '오류 메시지 (기본 한국어, Accept-Language: en 지정 시 영어)'
          example: 요청이 너무 많습니다. 잠시 후 다시 시도해주세요.
          type: string
      type: object
    domain.InternalServerError:
      properties:
        message:
          description: 오류 메시지 (지역화하지 않습니다)
          example: Internal Server Error
          type: string
        requestID:
          description: 문의 시 참조할 요청 식별자 (응답의 X-Request-Id 헤더와 같은 값)
          example: bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk
          type: string
      type: object
    domain.KeywordProviderUnavailableError:
      properties:
        code:
          description: 오류 코드
          example: KEYWORD_METRICS_PROVIDER_UNAVAILABLE
          type: string
        message:
          description: '오류 메시지 (기본 한국어, Accept-Language: en 지정 시 영어)'
          example: 키워드 지표 조회에 실패했습니다. 잠시 후 다시 시도해주세요
          type: string
      type: object
    domain.KeywordMetricsNotConfiguredError:
      properties:
        code:
          description: 오류 코드
          example: KEYWORD_METRICS_NOT_CONFIGURED
          type: string
        message:
          description: '오류 메시지 (기본 한국어, Accept-Language: en 지정 시 영어)'
          example: 키워드 지표 기능이 아직 활성화되지 않았습니다
          type: string
      type: object
    domain.GoogleKeywordMetricsItemDTO:
      properties:
        keyword:
          description: 키워드 (요청 원문 그대로)
          example: protein powder
          type: string
        metrics:
          $ref: '#/components/schemas/domain.GoogleKeywordMetricsDTO'
      required:
        - keyword
      type: object
    domain.GoogleKeywordMetricsDTO:
      description: 검색 지표 (null = 데이터 없음)
      properties:
        cpc:
          description: 평균 클릭당 비용 (USD)
          example: 1.66
          type: number
        keywordDifficulty:
          description: SEO 난이도 (0~100)
          example: 32
          type: integer
        monthlySearches:
          description: 최근 12개월 월별 검색량
          items:
            $ref: '#/components/schemas/domain.GoogleMonthlySearchDTO'
          type: array
          uniqueItems: false
        searchIntent:
          description: 검색 의도 (informational | navigational | commercial | transactional)
          example: transactional
          type: string
        searchVolume:
          description: 월평균 검색량. null = Google Ads 제한 카테고리(의료·금융 등)로 검색량 비공개
          example: 301000
          type: integer
        searchVolumeTrend:
          $ref: '#/components/schemas/domain.GoogleSearchVolumeTrendDTO'
      type: object
    domain.GoogleMonthlySearchDTO:
      properties:
        month:
          description: 월 (1~12)
          example: 6
          type: integer
        searchVolume:
          description: 해당 월 검색량
          example: 450000
          type: integer
        year:
          description: 연도
          example: 2026
          type: integer
      required:
        - month
        - year
      type: object
    domain.GoogleSearchVolumeTrendDTO:
      description: 기간별 검색량 증감률 (%)
      properties:
        monthly:
          description: 전월 대비 (%)
          example: -33
          type: number
        quarterly:
          description: 전분기 대비 (%)
          example: 50
          type: number
        yearly:
          description: 전년 대비 (%)
          example: 50
          type: number
      type: object
  securitySchemes:
    OrgAPIKeyAuth:
      description: '"조직 API 키를 입력하세요. 예: ''cs_live_xxxx''"'
      in: header
      name: API-Key
      type: apiKey

````