# 1018-App-Smart Keyword Recommendations

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /keyword/recommend:
    post:
      summary: 1018-App-Smart Keyword Recommendations
      deprecated: false
      description: >-
        Get smart keyword recommendations for an app (rank, search volume,
        results, coverage).
      operationId: 1018_App_Smart Keyword Recommendations
      tags:
        - II. List of Interfaces/1. application Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appId:
                  type: string
                  description: App ID
                  examples:
                    - '444934666'
                region:
                  type: string
                  description: Country/Region
                  examples:
                    - CN
                device:
                  type: string
                  description: AS apps only
                  examples:
                    - IPHONE
                keyword:
                  type: string
                  description: |-
                    Keyword
                    （Optional）
                  examples:
                    - qq
                cover:
                  type: boolean
                  description: Is covered keyword
                  examples:
                    - true
                limit:
                  type: string
                  description: Default Query 200
                  examples:
                    - TOP_200
              required:
                - keyword
              x-apifox-orders:
                - appId
                - region
                - device
                - keyword
                - cover
                - limit
              x-apifox-ignore-properties: []
            example:
              appId: '444934666'
              region: CN
              keyword: qq
              device: IPHONE
              cover: true
              limit: TOP_200
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOListRecommendKeywordVO'
              example:
                requestParam:
                  appId: '444934666'
                  region: CN
                  keyword: qq
                  device: IPHONE
                  cover: true
                  limit: TOP_200
                result:
                  - keyword: qq
                    rank: 1
                    relation: 100
                    searchVolume: 95
                    num: 206
                    cover: true
                creditsCost:
                  requestCredits: 0
                  baseCredits: 100
                  extraCredits: 0
                  totalCostCredits: 100
                next: null
          headers: {}
          x-apifox-name: ''
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: II. List of Interfaces/1. application Services
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-478038421-run
components:
  schemas:
    OpenApiBaseVOListRecommendKeywordVO:
      type: object
      properties:
        requestParam:
          $ref: '#/components/schemas/RecommendKeywordQuery'
          description: Your request param.
        result:
          type: array
          items:
            $ref: '#/components/schemas/RecommendKeywordVO'
            description: ''
          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: ''
    RecommendKeywordVO:
      type: object
      properties:
        keyword:
          type: string
          description: ''
        rank:
          type: integer
          description: ''
        relation:
          type: integer
          description: ''
        searchVolume:
          type: integer
          description: ''
        num:
          type: integer
          description: ''
        cover:
          type: boolean
          description: ''
      x-apifox-orders:
        - keyword
        - rank
        - relation
        - searchVolume
        - num
        - cover
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    RecommendKeywordQuery:
      type: object
      properties:
        appId:
          type: string
          description: ''
          examples:
            - com.moye.shelter
        region:
          type: string
          description: ''
          examples:
            - US
        keyword:
          type: string
          description: ''
          examples:
            - hello
        device:
          type: string
          description: ''
          enum:
            - IPHONE
            - IPAD
          x-apifox-enum:
            - value: IPHONE
              name: IPHONE
              description: IPHONE
            - value: IPAD
              name: IPAD
              description: IPAD
          examples:
            - IPHONE,IPAD
        cover:
          type: boolean
          description: ''
          examples:
            - true
        limit:
          type: string
          description: ''
          enum:
            - TOP_200
            - TOP_400
          x-apifox-enum:
            - value: TOP_200
              name: TOP_200
              description: TOP_200
            - value: TOP_400
              name: TOP_400
              description: TOP_400
          examples:
            - '200'
      x-apifox-orders:
        - appId
        - region
        - keyword
        - device
        - cover
        - limit
      required:
        - appId
        - limit
      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: []

```