# 1009-App-Competitor Comparison

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /app/competitor-info:
    post:
      summary: 1009-App-Competitor Comparison
      deprecated: false
      description: >-
        Compare the app with specified competitors (category rank, covered
        keywords, rating, release count, visibility score, etc.).
      operationId: 1009_App_Competitor Comparison
      tags:
        - II. List of Interfaces/1. application Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appId:
                  type: string
                  description: App ID
                  examples:
                    - '389801252'
                region:
                  type: string
                  description: Country/Region
                  examples:
                    - CN
                competitorIds:
                  type: array
                  description: Competitors (up to 5); required, at least one
                  examples:
                    - - '284882215'
                      - '422689480'
              required:
                - competitorIds
              x-apifox-orders:
                - appId
                - region
                - competitorIds
              x-apifox-ignore-properties: []
            example:
              region: CN
              appId: '389801252'
              competitorIds:
                - '284882215'
                - '422689480'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOListAppCompetitorVO'
              examples:
                '1':
                  summary: Success Example
                  value:
                    requestParam:
                      region: CN
                      appId: '389801252'
                      competitorIds:
                        - '284882215'
                        - '422689480'
                    result:
                      - appId: '389801252'
                        title: Instagram
                        icon: >-
                          https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/40/92/25/409225c7-3545-fc45-1bbb-62a6745289ad/Prod-0-0-1x_U007epad-0-1-0-sRGB-85-220.png/88x88w.png
                        rankedKeywords: 221156
                        top3Keywords: 25943
                        download: 128316
                        revenue: 465
                        rating: 4.55
                        visibilityScore: 93
                        versionCount: 67
                        ranks:
                          - name: Apps
                            rank: 217
                          - name: Photo & Video
                            rank: 15
                    creditsCost:
                      requestCredits: 0
                      baseCredits: 200
                      extraCredits: 0
                      totalCostCredits: 200
                    next: null
                '2':
                  summary: Success Example
                  value:
                    requestParam:
                      region: CN
                      appId: '389801252'
                      competitorIds:
                        - '284882215'
                        - '422689480'
                    result:
                      - appId: '389801252'
                        title: Instagram
                        icon: >-
                          https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/40/92/25/409225c7-3545-fc45-1bbb-62a6745289ad/Prod-0-0-1x_U007epad-0-1-0-sRGB-85-220.png/88x88w.png
                        rankedKeywords: 221156
                        top3Keywords: 25943
                        download: 128316
                        revenue: 465
                        rating: 4.55
                        visibilityScore: 93
                        versionCount: 67
                        ranks:
                          - name: Apps
                            rank: 217
                          - name: Photo & Video
                            rank: 15
                    creditsCost:
                      requestCredits: 0
                      baseCredits: 200
                      extraCredits: 0
                      totalCostCredits: 200
                    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-478038410-run
components:
  schemas:
    OpenApiBaseVOListAppCompetitorVO:
      type: object
      properties:
        requestParam:
          $ref: '#/components/schemas/AppCompetitorQuery'
          description: Your request param.
        result:
          type: array
          items:
            $ref: '#/components/schemas/AppCompetitorVO'
            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: ''
    AppCompetitorVO:
      type: object
      properties:
        appId:
          type: string
          description: ''
        title:
          type: string
          description: ''
        icon:
          type: string
          description: ''
        rankedKeywords:
          type: integer
          description: ''
        top3Keywords:
          type: integer
          description: ''
        download:
          type: integer
          description: ''
          format: int64
        revenue:
          type: integer
          description: ''
          format: int64
        rating:
          type: number
          description: ''
        visibilityScore:
          type: integer
          description: ''
        versionCount:
          type: integer
          description: ''
        ranks:
          type: array
          items:
            $ref: '#/components/schemas/CategoryRank'
            description: com.xiaoxi.openapi.model.vo.AppCompetitorVO.CategoryRank
          description: ''
      x-apifox-orders:
        - appId
        - title
        - icon
        - rankedKeywords
        - top3Keywords
        - download
        - revenue
        - rating
        - visibilityScore
        - versionCount
        - ranks
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    CategoryRank:
      type: object
      properties:
        name:
          type: string
          description: ''
        rank:
          type: integer
          description: ''
      x-apifox-orders:
        - name
        - rank
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    AppCompetitorQuery:
      type: object
      properties:
        region:
          type: string
          description: ''
          examples:
            - US
        appId:
          type: string
          description: ''
          examples:
            - '1468070757'
        competitorIds:
          type: array
          items:
            type: string
          description: ''
          minItems: 1
          maxItems: 5
          examples:
            - - '479516143'
              - '479516144'
            - - '479516143'
              - '479516144'
      x-apifox-orders:
        - region
        - appId
        - competitorIds
      required:
        - region
        - appId
        - competitorIds
      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: []

```