# App Keyword

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /expose/keyword/metrics-rank:
    post:
      summary: App Keyword
      deprecated: false
      description: |-
        Credits Cost

        | Cost Type     | Cost Credits |
        | ------------- | ---------- |
        | Request Credits | 1          |

        Credits Cost of Each Metrics

        **Rank**
        | Cost Type     | Cost Credits |
        | ------------- | ---------- |
        | Base Credits    | 10         |



        **Installs**
        | Cost Type     | Cost Credits |
        | ------------- | ---------- |
        | Base Credits    | 10         |
      tags:
        - LIST OF APIS
      parameters:
        - name: x-openapi-key
          in: header
          description: ''
          required: true
          example: Your License
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                appId:
                  type: string
                  description: Application ID or packageName
                region:
                  type: string
                  description: Two character region code,like US.
                  default: US
                metrics:
                  type: array
                  items:
                    type: string
                    enum:
                      - RANK
                      - INSTALL
                    x-apifox-enum:
                      - value: RANK
                        name: ''
                        description: Rank
                      - value: INSTALL
                        name: ''
                        description: Installs
                  description: Keyword Metrics
                keywords:
                  type: array
                  items:
                    type: string
                  description: Filtered Keywords
                  maxItems: 5
                  nullable: true
                device:
                  type: string
                  description: App Store Device, only for AppStore query.
                  enum:
                    - IPHONE
                    - IPAD
                  x-apifox-enum:
                    - value: IPHONE
                      name: ''
                      description: IPHONE
                    - value: IPAD
                      name: ''
                      description: IPAD
                  nullable: true
                timezone:
                  type: integer
                  description: Your timezone,enter 8 for UTC+8,enter -7 for UTC-7.
                  nullable: true
              x-apifox-refs: {}
              x-apifox-orders:
                - appId
                - region
                - metrics
                - keywords
                - device
                - timezone
              required:
                - appId
                - region
                - metrics
                - timezone
              x-apifox-ignore-properties: []
            example:
              appId: '416048305'
              region: KR
              metrics:
                - RANK
                - INSTALL
              keywords:
                - alight motion
                - 북플레이
                - alight motion
              device: IPHONE
              timezone: 0
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestParam:
                    $ref: '#/components/schemas/KeywordRankMetricsQuery'
                    description: Your request param.
                  result:
                    type: array
                    items:
                      description: ''
                      type: object
                      x-apifox-refs:
                        01HY25M6XJZYNJ28EHJGE16A8B:
                          $ref: '#/components/schemas/KeywordRankMetricsVO'
                          x-apifox-overrides:
                            keyword: &ref_1
                              type: string
                              description: Keyword
                              nullable: true
                            rank: &ref_0
                              $ref: '#/components/schemas/KeywordInfo'
                              description: Rank
                            installs: *ref_0
                      x-apifox-orders:
                        - 01HY25M6XJZYNJ28EHJGE16A8B
                      properties:
                        keyword: *ref_1
                        rank: *ref_0
                        installs: *ref_0
                      x-apifox-ignore-properties:
                        - keyword
                        - rank
                        - installs
                    description: Your response.
                    nullable: true
                  creditsCost:
                    $ref: '#/components/schemas/OpenApiPointCostVO'
                    description: Credits cost info.
                x-apifox-refs: {}
                x-apifox-orders:
                  - requestParam
                  - result
                  - creditsCost
                x-apifox-ignore-properties: []
              example:
                code: 200
                msg: success
                data:
                  requestParam:
                    appId: '416048305'
                    region: KR
                    metrics:
                      - RANK
                      - INSTALL
                    keywords:
                      - alight motion
                      - 북플레이
                      - alight motion
                    device: IPHONE
                    timezone: 0
                  result:
                    - keyword: alight motion
                      rank:
                        value: 37
                        date: '2024-05-14'
                    - keyword: 북플레이
                      rank:
                        value: 137
                        date: '2024-05-14'
                  creditsCost:
                    requestCredits: 1
                    baseCredits: 20
                    extraCredits: 0
                    totalCostCredits: 21
          headers: {}
          x-apifox-name: Success
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: LIST OF APIS
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-175186479-run
components:
  schemas:
    OpenApiPointCostVO:
      type: object
      properties:
        requestCredits:
          type: integer
          description: ''
          nullable: true
        baseCredits:
          type: integer
          description: ''
          nullable: true
        extraCredits:
          type: integer
          description: ''
          nullable: true
        totalCostCredits:
          type: integer
          description: ''
          nullable: true
      x-apifox-orders:
        - requestCredits
        - baseCredits
        - extraCredits
        - totalCostCredits
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    KeywordRankMetricsVO:
      type: object
      properties:
        keyword:
          type: string
          description: Keyword
          nullable: true
        rank: *ref_0
        installs: *ref_0
      x-apifox-orders:
        - keyword
        - rank
        - installs
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    KeywordInfo:
      type: object
      properties:
        value:
          type: integer
          description: Value
          nullable: true
        date:
          type: string
          description: Date
          x-apifox-mock: '@datetime'
          nullable: true
      x-apifox-orders:
        - value
        - date
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    KeywordRankMetricsQuery:
      type: object
      properties:
        appId:
          type: string
          description: Application ID or packageName
          nullable: true
        region:
          type: string
          description: Two character region code,like US.
          default: US
          nullable: true
        metrics:
          type: array
          items:
            type: string
            enum:
              - RANK
              - INSTALL
            x-apifox-enum:
              - value: RANK
                name: ''
                description: RANK
              - value: INSTALL
                name: ''
                description: INSTALL
          description: Keyword Metrics
          nullable: true
        keywords:
          type: array
          items:
            type: string
          description: Filtered Keywords
          maxItems: 5
          nullable: true
        device:
          type: string
          description: App Store Device, only for AppStore query.
          enum:
            - IPHONE
            - IPAD
          x-apifox-enum:
            - value: IPHONE
              name: ''
              description: IPHONE
            - value: IPAD
              name: ''
              description: IPAD
          nullable: true
        timezone:
          type: integer
          description: Your timezone,enter 8 for UTC+8,enter -7 for UTC-7.
          nullable: true
      x-apifox-orders:
        - appId
        - region
        - metrics
        - keywords
        - device
        - timezone
      required:
        - appId
        - region
        - metrics
        - timezone
      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
    description: Api Server
security:
  - apikey-header-x-openapi-key: []

```
