# 1011-App-Covered Keywords

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /keyword/metrics:
    post:
      summary: 1011-App-Covered Keywords
      deprecated: false
      description: >-
        Query app keyword metrics (correlation, rank, search volume, result
        count, traffic share, tags, etc.).
      operationId: 1011_App_Covered Keywords
      tags:
        - II. List of Interfaces/1. application Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appId:
                  type: string
                  description: App ID
                  examples:
                    - '835599320'
                region:
                  type: string
                  description: Country/Region
                  examples:
                    - US
                device:
                  type: string
                  description: AS apps only
                  examples:
                    - IPHONE
                date:
                  type: string
                  description: >-
                    Query date,If the parameter is not passed, query today by
                    default.
                  nullable: true
                metrics:
                  type: string
                  description: >-
                    Metrics; configure per need, separate multiple metrics with
                    commas
                  examples:
                    - - CORRELATION
                      - RANK
                      - CHANCE
                      - DIFFICULTY
                      - INSTALL
                      - VOLUME
                      - RESULTS
                      - TAG
                keywords:
                  type: string
                  description: >-
                    If keyword is provided, only the specified keyword is
                    queried (max 200)
                  examples:
                    - - hi
                      - hello
                sortBy:
                  type: string
                  description: >-
                    Choose one of three (optional),
                    ex:RANK、CORRELATION、VOLUME.If empty, defaults to correlation
                    query.
                  examples:
                    - CORRELATION
                mark:
                  type: integer
                  description: ''
                limit:
                  type: string
                  description: Default Query 200
                  examples:
                    - ALL
                size:
                  type: string
                  description: >-
                    Page size; only applies when limit is ALL; default SIZE_100
                    (100 items per page)
                  examples:
                    - SIZE_100,SIZE_200,SIZE_500
              x-apifox-orders:
                - appId
                - region
                - device
                - date
                - metrics
                - keywords
                - sortBy
                - mark
                - limit
                - size
              x-apifox-ignore-properties: []
            example:
              appId: '835599320'
              metrics:
                - CORRELATION
                - RANK
                - CHANCE
                - DIFFICULTY
                - INSTALL
                - VOLUME
                - RESULTS
                - TAG
              device: IPHONE
              region: US
              date: '2026-07-14'
              sortBy: CORRELATION
              limit: ALL
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOWanKaKeywordMetricsV2VO'
              example:
                requestParam:
                  appId: '835599320'
                  region: US
                  device: IPHONE
                  metrics:
                    - CORRELATION
                    - RANK
                    - CHANCE
                    - DIFFICULTY
                    - INSTALL
                    - VOLUME
                    - RESULTS
                    - TAG
                  keywords: null
                  limit: TOP_200
                result:
                  keywords:
                    - keyword: tik
                      ranking:
                        status: null
                        num: null
                        trend:
                          - 135
                          - 135
                          - 133
                      corr: 100
                      searchVolume:
                        num: 71
                        trend:
                          - 70
                          - 71
                          - 71
                      searchResults:
                        num: 184
                        apps:
                          - '835599320'
                          - '389801252'
                          - '447188370'
                      chance: 66
                      diff: 54
                      install:
                        top5:
                          - '835599320'
                          - '389801252'
                          - '447188370'
                          - '333903271'
                          - '544007664'
                        per: 0.8772
                        value: 4473
                      tag:
                        isAsa: true
                        isBrand: true
                        asaApps:
                          - '284815942'
                          - '535886823'
                          - '6451504705'
                        brandApps:
                          - '1596140572'
                          - '6502126302'
                          - '6720712299'
                          - '6753927915'
                        meta:
                          - APP_NAME
                  dates:
                    - '2025-11-28'
                    - '2025-11-29'
                    - '2025-11-30'
                    - '2025-12-01'
                    - '2025-12-02'
                    - '2025-12-03'
                    - '2025-12-04'
                  iconPrefix: https://is1-ssl.mzstatic.com/image/thumb
                  appInfoMap:
                    '282614216':
                      appName: eBay online shopping & selling
                      icon: >-
                        /Purple211/v4/36/c0/c4/36c0c492-bde2-897b-5f9e-b30f4553c274/AppIcon-0-0-1x_U007epad-0-1-0-85-220.png/88x88w.png
                    '284815942':
                      appName: Google
                      icon: >-
                        /Purple221/v4/60/74/91/607491e0-6103-0313-b438-478b01eec73d/logo_gsa_gradient_ios_color-0-1x_U007epad-0-0-0-1-0-0-sRGB-0-0-85-220-0.png/88x88w.png
                    '284882215':
                      appName: Facebook
                      icon: >-
                        /Purple211/v4/7a/01/59/7a01597f-482a-1736-35fe-9aa0432aadab/Icon-Production-0-0-1x_U007epad-0-1-0-85-220.png/88x88w.png
                creditsCost:
                  requestCredits: 0
                  baseCredits: 500
                  extraCredits: 0
                  totalCostCredits: 500
                next: null
          headers: {}
          x-apifox-name: Success
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: II. List of Interfaces/1. application Services
      x-apifox-status: developing
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-478038412-run
components:
  schemas:
    OpenApiBaseVOWanKaKeywordMetricsV2VO:
      type: object
      properties:
        requestParam:
          $ref: '#/components/schemas/WanKaKeywordMetricsQuery'
          description: Your request param.
        result:
          $ref: '#/components/schemas/WanKaKeywordMetricsV2VO'
          description: Your response.
        creditsCost:
          $ref: '#/components/schemas/OpenApiPointCostVO'
          description: Credits cost info.
        next:
          $ref: '#/components/schemas/PaginationInfo'
          description: Next page info
      x-apifox-orders:
        - requestParam
        - result
        - creditsCost
        - next
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    PaginationInfo:
      type: object
      properties:
        taskId:
          type: string
          description: Task ID
        pageKey:
          type: string
          description: Page Key
        totalCount:
          type: integer
          description: Total Count
          format: int64
        totalPages:
          type: integer
          description: Total Pages
          format: int64
      x-apifox-orders:
        - taskId
        - pageKey
        - totalCount
        - totalPages
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    OpenApiPointCostVO:
      type: object
      properties:
        requestCredits:
          type: integer
          description: ''
        baseCredits:
          type: integer
          description: ''
        extraCredits:
          type: integer
          description: ''
        totalCostCredits:
          type: integer
          description: ''
      x-apifox-orders:
        - requestCredits
        - baseCredits
        - extraCredits
        - totalCostCredits
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    WanKaKeywordMetricsV2VO:
      type: object
      properties:
        keywords:
          type: array
          items:
            $ref: '#/components/schemas/KeywordInfo'
            description: >-
              com.xiaoxi.openapi.model.vo.wanka.WanKaKeywordMetricsV2VO.KeywordInfo
          description: ''
        dates:
          type: array
          items:
            type: string
          description: ''
        iconPrefix:
          type: string
          description: ''
        appInfoMap:
          $ref: '#/components/schemas/MapAppInfoVO'
          description: ''
      x-apifox-orders:
        - keywords
        - dates
        - iconPrefix
        - appInfoMap
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    MapAppInfoVO:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/key'
      x-apifox-orders:
        - key
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    key:
      type: object
      properties:
        appId:
          type: string
          description: ''
        appName:
          type: string
          description: ''
        icon:
          type: string
          description: ''
      x-apifox-orders:
        - appId
        - appName
        - icon
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    KeywordInfo:
      type: object
      properties:
        keyword:
          type: string
          description: ''
        ranking:
          $ref: '#/components/schemas/Ranking'
          description: ''
          default: new Ranking()
        corr:
          type: integer
          description: ''
        searchVolume:
          $ref: '#/components/schemas/SearchVolume'
          description: ''
          default: new SearchVolume()
        searchResults:
          $ref: '#/components/schemas/SearchResults'
          description: ''
          default: new SearchResults()
        chance:
          type: integer
          description: ''
        diff:
          type: integer
          description: ''
        install:
          $ref: '#/components/schemas/Inst'
          description: private Integer inst;
          default: new Inst()
        tag:
          $ref: '#/components/schemas/Tag'
          description: private List<AppInfo> top5;
          default: new Tag()
      x-apifox-orders:
        - keyword
        - ranking
        - corr
        - searchVolume
        - searchResults
        - chance
        - diff
        - install
        - tag
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Tag:
      type: object
      properties:
        isAsa:
          type: boolean
          description: ''
        isBrand:
          type: boolean
          description: ''
        asaApps:
          type: array
          items:
            type: string
          description: ''
        brandApps:
          type: array
          items:
            type: string
          description: ''
        meta:
          type: array
          items:
            type: string
            enum:
              - APP_NAME
              - SUB_TITLE
            x-apifox-enum:
              - value: APP_NAME
                name: APP_NAME
                description: App Name
              - value: SUB_TITLE
                name: SUB_TITLE
                description: Subtitle
          description: Meta tags
      x-apifox-orders:
        - isAsa
        - isBrand
        - asaApps
        - brandApps
        - meta
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Inst:
      type: object
      properties:
        top5:
          type: array
          items:
            type: string
          description: ''
        per:
          type: number
          description: ''
        value:
          type: integer
          description: ''
      x-apifox-orders:
        - top5
        - per
        - value
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    SearchResults:
      type: object
      properties:
        num:
          type: integer
          description: ''
        apps:
          type: array
          items:
            type: string
          description: ''
      x-apifox-orders:
        - num
        - apps
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    SearchVolume:
      type: object
      properties:
        num:
          type: integer
          description: ''
        trend:
          type: array
          items:
            type: integer
          description: ''
      x-apifox-orders:
        - num
        - trend
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Ranking:
      type: object
      properties:
        status:
          type: string
          description: ''
          enum:
            - NEW
            - OUT
          x-apifox-enum:
            - value: NEW
              name: NEW
              description: NEW
            - value: OUT
              name: OUT
              description: OUT
        num:
          type: integer
          description: ''
        trend:
          type: array
          items:
            type: integer
          description: ''
      x-apifox-orders:
        - status
        - num
        - trend
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    WanKaKeywordMetricsQuery:
      type: object
      properties:
        appId:
          type: string
          description: ''
          examples:
            - '835599320'
        region:
          type: string
          description: Two character region code,like US.
          default: US
          examples:
            - US
        device:
          type: string
          description: App Store Device, only for AppStore query.
          enum:
            - IPHONE
            - IPAD
          x-apifox-enum:
            - value: IPHONE
              name: IPHONE
              description: IPHONE
            - value: IPAD
              name: IPAD
              description: IPAD
          examples:
            - IPHONE,IPAD
        metrics:
          type: array
          items:
            type: string
            enum:
              - CORRELATION
              - RANK
              - CHANCE
              - DIFFICULTY
              - INSTALL
              - VOLUME
              - RESULTS
              - TAG
            x-apifox-enum:
              - value: CORRELATION
                name: CORRELATION
                description: CORRELATION
              - value: RANK
                name: RANK
                description: RANK
              - value: CHANCE
                name: CHANCE
                description: CHANCE
              - value: DIFFICULTY
                name: DIFFICULTY
                description: DIFFICULTY
              - value: INSTALL
                name: INSTALL
                description: INSTALL
              - value: VOLUME
                name: VOLUME
                description: VOLUME
              - value: RESULTS
                name: RESULTS
                description: RESULTS
              - value: TAG
                name: TAG
                description: TAG
          description: App Metrics List
          examples:
            - |-
              CORRELATION：相关度
              RANK：排名+近7天排名趋势
              CHANCE：机会得分
              DIFFICULTY：难度得分
              INSTALL：安装量+安装占比+Top5应用
              VOLUME：搜索指数+近7天搜索指数
              RESULTS：搜索结果数+Top50结果应用
              TAG：标签分类+典型应用
        keywords:
          type: array
          items:
            type: string
          description: keywords
          maxItems: 200
          examples:
            - - hi
              - hello
            - - hi
              - hello
        limit:
          type: string
          description: ''
          enum:
            - TOP_200
            - TOP_400
            - ALL
          x-apifox-enum:
            - value: TOP_200
              name: TOP_200
              description: TOP_200
            - value: TOP_400
              name: TOP_400
              description: TOP_400
            - value: ALL
              name: ALL
              description: ALL
          examples:
            - '200'
      x-apifox-orders:
        - appId
        - region
        - device
        - metrics
        - keywords
        - limit
      required:
        - appId
        - metrics
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    apikey-header-x-openapi-key:
      type: apiKey
      in: header
      name: x-openapi-key
servers:
  - url: https://api.foxdata.com/apiv1/open-api
    description: Api Server
security:
  - apikey-header-x-openapi-key: []

```
