# 3005-ASA Tab Rate Result

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /asa-tab-rate/result:
    post:
      summary: 3005-ASA Tab Rate Result
      deprecated: false
      description: Query bidding-share result by task id.
      operationId: 3005_ASA_Tab_Rate_Result
      tags:
        - II. List of Interfaces/3. ASA Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema: &ref_0
              $ref: '#/components/schemas/AsaTabRateResultQuery'
              description: ''
            example:
              taskId: 99982a12-301a-41af-b756-ab9c34cce1f7
              type: SEARCH
              region: US
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOAsaTabRateResultVO'
          headers: {}
          x-apifox-name: ''
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: II. List of Interfaces/3. ASA Services
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-478038439-run
components:
  schemas:
    AsaTabRateResultQuery:
      type: object
      properties:
        taskId:
          type: string
          description: Task id returned by the trigger endpoint.
        type:
          type: string
          description: Placement, TODAY or SEARCH.
          enum:
            - TODAY
            - SEARCH
          x-apifox-enum:
            - value: TODAY
              name: TODAY
              description: Today tab
            - value: SEARCH
              name: SEARCH
              description: Search tab
        region:
          type: string
          description: Two character region code,like US.
          default: US
      x-apifox-orders:
        - taskId
        - type
        - region
      required:
        - taskId
        - type
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    OpenApiBaseVOAsaTabRateResultVO:
      type: object
      properties:
        requestParam: *ref_0
        result:
          $ref: '#/components/schemas/AsaTabRateResultVO'
          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: ''
    AsaTabRateResultVO:
      type: object
      properties:
        status:
          type: string
          description: >-
            Task status: PENDING (within 2 minutes of creation or no data yet)
            or SUCCESS.
          enum:
            - PENDING
            - SUCCESS
            - FAILED
          x-apifox-enum:
            - value: PENDING
              name: PENDING
              description: 进行中：任务创建 2 分钟内、或暂无数据未超时
            - value: SUCCESS
              name: SUCCESS
              description: 已完成：已超过 2 分钟窗口且有数据
            - value: FAILED
              name: FAILED
              description: 已失败：超过 4 分钟仍无数据
        items:
          type: array
          items:
            $ref: '#/components/schemas/AsaTabRateItemVO'
            description: 3005-ASA 实时竞价占比 - 单个竞价应用结果
          description: Bidding share items, ordered by num desc.
      x-apifox-orders:
        - status
        - items
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    AsaTabRateItemVO:
      type: object
      properties:
        appId:
          type: string
          description: Application id.
        icon:
          type: string
          description: Application icon.
        title:
          type: string
          description: Application title.
        num:
          type: integer
          description: Bidding occurrence count.
          format: int64
        percentage:
          type: number
          description: Bidding share, num / total num of the placement, 0~1.
      x-apifox-orders:
        - appId
        - icon
        - title
        - num
        - percentage
      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: []

```
