# 4003-Keyword Search Details

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /keyword/search-detail:
    post:
      summary: 4003-Keyword Search Details
      deprecated: false
      description: >-
        Query detailed keyword data by keyword, country, app market, and
        metrics.
      operationId: 4003_Keyword Search Details
      tags:
        - II. List of Interfaces/4. Kerword research Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appstore:
                  type: string
                  description: App Store
                  examples:
                    - AS
                region:
                  type: string
                  description: Country/Region
                  examples:
                    - US
                keyword:
                  type: string
                  description: Keyword
                  examples:
                    - music
                metrics:
                  type: array
                  description: >-
                    SUMMARY returns summary info; DETAIL returns detailed info
                    including search results.
                  examples:
                    - - SUMMARY
                      - DETAIL
                limit:
                  type: string
                  description: >-
                    TOP_200 returns top 200 apps; TOP_10 returns top 10; ALL
                    returns all apps
                  examples:
                    - TOP_200
              x-apifox-orders:
                - appstore
                - region
                - keyword
                - metrics
                - limit
              x-apifox-ignore-properties: []
            example:
              appstore: AS
              region: US
              keyword: music
              metrics:
                - SUMMARY
                - DETAIL
              limit: TOP_200
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOWanKaAppInfoVO'
          headers: {}
          x-apifox-name: Success
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: II. List of Interfaces/4. Kerword research Services
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-478038442-run
components:
  schemas:
    OpenApiBaseVOWanKaAppInfoVO:
      type: object
      properties:
        requestParam:
          $ref: '#/components/schemas/WankaAppInfoQuery'
          description: Your request param.
        result:
          $ref: '#/components/schemas/WanKaAppInfoVO'
          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: ''
    WanKaAppInfoVO:
      type: object
      properties:
        appId:
          type: string
          description: ''
        appName:
          type: string
          description: ''
        icon:
          type: string
          description: ''
        subTitle:
          type: string
          description: ''
        descriptions:
          type: string
          description: ''
        promotionalText:
          type: string
          description: ''
        category:
          type: string
          description: ''
        categoryId:
          type: string
          description: ''
        status:
          type: string
          description: ''
          enum:
            - NOT_EXIST
            - RESERVE
            - ONLINE
            - PRE_ORDER
            - OFFLINE
            - ACTIVITY
          x-apifox-enum:
            - value: NOT_EXIST
              name: NOT_EXIST
              description: NOT_EXIST
            - value: RESERVE
              name: RESERVE
              description: RESERVE
            - value: ONLINE
              name: ONLINE
              description: ONLINE
            - value: PRE_ORDER
              name: PRE_ORDER
              description: PRE_ORDER
            - value: OFFLINE
              name: OFFLINE
              description: OFFLINE
            - value: ACTIVITY
              name: ACTIVITY
              description: ACTIVITY
        screenshot:
          $ref: '#/components/schemas/Screenshot'
          description: ''
        videos:
          $ref: '#/components/schemas/Videos'
          description: ''
        gpScreenshots:
          type: array
          items:
            type: string
          description: (仅GP)Splash Screen
          default: new ArrayList<>()
        gpVideos:
          type: array
          items:
            $ref: '#/components/schemas/VideoVO'
            description: com.xiaoxi.openapi.model.vo.OpenapiAppInfoVO.VideoVO
          description: (仅GP)Video
      x-apifox-orders:
        - appId
        - appName
        - icon
        - subTitle
        - descriptions
        - promotionalText
        - category
        - categoryId
        - status
        - screenshot
        - videos
        - gpScreenshots
        - gpVideos
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    VideoVO:
      type: object
      properties:
        image:
          type: string
          description: ''
        video:
          type: string
          description: ''
      x-apifox-orders:
        - image
        - video
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Videos:
      type: object
      properties:
        iPhone:
          type: array
          items: &ref_0
            $ref: '#/components/schemas/Video'
            description: com.xiaoxi.openapi.feign.appstore.entity.AsAppInfo.Video
          description: ''
        iPad:
          type: array
          items: *ref_0
          description: ''
      x-apifox-orders:
        - iPhone
        - iPad
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Video:
      type: object
      properties:
        image:
          type: string
          description: ''
        video:
          type: string
          description: ''
      x-apifox-orders:
        - image
        - video
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Screenshot:
      type: object
      properties:
        iPhone:
          type: array
          items:
            type: string
          description: ''
        iPhone65:
          type: array
          items:
            type: string
          description: ''
        iPad:
          type: array
          items:
            type: string
          description: ''
        appleWatch:
          type: array
          items:
            type: string
          description: ''
        iPhoneD74:
          type: array
          items:
            type: string
          description: ''
        mac:
          type: array
          items:
            type: string
          description: ''
      x-apifox-orders:
        - iPhone
        - iPhone65
        - iPad
        - appleWatch
        - iPhoneD74
        - mac
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    WankaAppInfoQuery:
      type: object
      properties:
        appId:
          type: string
          description: ''
          examples:
            - com.moye.shelter
        region:
          type: string
          description: ''
          examples:
            - US
        language:
          type: string
          description: ''
          examples:
            - en_US
      x-apifox-orders:
        - appId
        - region
        - language
      required:
        - appId
        - region
      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: []

```