# Channel/Campaign/Ad-set/Ad level ads attribution

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /{version}/api/get/ad-analysis/list:
    post:
      summary: Channel/Campaign/Ad-set/Ad level ads attribution
      deprecated: false
      description: |-
        - Analyze your paid advertising performance across channels
        - Rate limits: 5 requests per second.
        - version: v2-4-2.
      tags:
        - Public API/Attribution/Ads
      parameters:
        - name: version
          in: path
          description: ''
          required: true
          example: v2-4-2
          schema:
            type: string
        - name: ApiKey
          in: header
          description: ''
          required: true
          example: '{{ApiKey}}'
          schema:
            type: string
            default: '{{ApiKey}}'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                start_date:
                  type: string
                  description: >-
                    The start date range of the event in ISO format, e.g.
                    1970-01-01, the time zone should be consistent with your
                    store settings.
                  x-apifox-mock: '{{$date.recent}}'
                end_date:
                  type: string
                  description: >-
                    The end date of the event in ISO format, e.g. 1970-01-01,
                    the time zone should be consistent with your store
                    settings.If you want to see the data for 1970-01-01, please
                    enter 1970-01-02.
                  x-apifox-mock: '{{$date.now}}'
                model:
                  type: string
                  description: >-
                    - First click

                    - Last click

                    - Linear

                    - Position

                    - Full Impact

                    - For other values, please refer to the “name” section in
                    the API documentation
                    (https://developer.attribuly.com/api-429980012)
                goal:
                  type: string
                  description: 'Attribution goal:  purchase/add_to_cart'
                page:
                  type: integer
                  description: The min is 1.
                page_size:
                  type: integer
                  description: The range is 1 to 100.
                dimension:
                  type: string
                  description: channel/campaign/ad_set/ad
              required:
                - start_date
                - end_date
                - dimension
                - model
                - goal
                - page
                - page_size
              x-apifox-orders:
                - start_date
                - end_date
                - dimension
                - model
                - goal
                - page
                - page_size
            example:
              start_date: string
              end_date: string
              dimension: channel
              model: first
              goal: purchase
              page: 1
              page_size: 20
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    description: 1:success; other:failed
                  message:
                    type: string
                    description: message
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                        description: total
                      page_size:
                        type: integer
                        description: page_size
                      records:
                        type: array
                        items:
                          type: object
                          properties:
                            channel:
                              type: string
                              description: channel
                            campaign:
                              type: string
                              description: campaign
                            ad_set:
                              type: string
                              description: ad set
                            ad_name:
                              type: string
                              description: ad name
                            new_lead_conversions:
                              type: number
                              description: Conversions of new lead.
                            conversions:
                              type: number
                              description: >-
                                Node conversions under corresponding attribution
                                goal.
                            conversion_value:
                              type: integer
                              description: >-
                                Node conversion value under corresponding
                                attribution goal.
                            new_order_conversion_value:
                              type: number
                              description: The conversion value of new order.
                            new_order_roas:
                              type: number
                              description: The new order of roas.
                            ad_net_conversion_value:
                              type: number
                              description: >-
                                The conversion value which pulled from ads
                                manager.
                            ad_net_roas:
                              type: number
                              description: The roas which pulled from ads manager.
                            spend:
                              type: number
                              description: >-
                                Spend is how much you’ve spent over a given
                                period of time.
                            cpa:
                              type: number
                              description: CPA=Spend/Purchase conversions.
                            roas:
                              type: number
                              description: ROAS=(Purchase conversion value/ Spend).
                            impressions:
                              type: integer
                              description: >-
                                Total impressions within the time range. It‘s
                                pulled from ads manager.
                            cpm:
                              type: number
                              description: |-
                                CPM=(Spend/Impressions)*1000.
                                CPM stands for cost per 1,000 impressions.
                            clicks:
                              type: integer
                              description: Numbers visitors click to your website.
                            cvr:
                              type: number
                              description: >-
                                CVR=(Purchase conversions/Clicks)*100%
                                CVR(conversion rate) is the percentage of link
                                clicks to your website that resulted in a
                                purchase.
                            cpc:
                              type: number
                              description: CPC=Spend/Clicks. CPC stands for cost per click.
                            ctr:
                              type: number
                              description: >-
                                CTR=(Clicks/Impressions)*100%. CTR stands for
                                click through rate.
                            outbound_clicks:
                              type: integer
                              description: >-
                                The number of clicks on links that take people
                                off Meta technologies.
                            outbound_ctr:
                              type: number
                              description: >-
                                Outbound CTR=(Outbound clicks/impressions)*100%.
                                The percentage of times people saw your ad and
                                performed an outbound click.
                            cost_per_outbound_click:
                              type: number
                              description: >-
                                Cost per outbound click=Spend/Outbound clicks.
                                The average cost for each outbound click.
                            view_through_conversions:
                              type: number
                              description: >-
                                Based on Attribuly purchase conversions, add
                                Facebook's view-through purchase
                                conversions(1-day view).
                            view_through_conversion_value:
                              type: number
                              description: >-
                                Based on Attribuly purchase conversion value,
                                add Facebook's view-through purchase conversion
                                value(1-day view).
                            view_through_roas:
                              type: number
                              description: >-
                                Purchase conversion value (Incl.
                                view-through)/Spend.
                            profit:
                              type: number
                              description: >-
                                Total sales-shipping-ad spend-product
                                cost(COGS)-taxes-payment processing fees.
                            margin:
                              type: number
                              description: Net Profit / Sales x 100%.
                          x-apifox-orders:
                            - channel
                            - campaign
                            - ad_set
                            - ad_name
                            - new_lead_conversions
                            - conversions
                            - conversion_value
                            - new_order_conversion_value
                            - new_order_roas
                            - ad_net_conversion_value
                            - ad_net_roas
                            - spend
                            - cpa
                            - roas
                            - impressions
                            - cpm
                            - clicks
                            - cvr
                            - cpc
                            - ctr
                            - outbound_clicks
                            - outbound_ctr
                            - cost_per_outbound_click
                            - view_through_conversions
                            - view_through_conversion_value
                            - view_through_roas
                            - profit
                            - margin
                    required:
                      - total
                      - page_size
                      - records
                    x-apifox-orders:
                      - total
                      - page_size
                      - records
                required:
                  - code
                  - message
                  - data
                x-apifox-orders:
                  - code
                  - message
                  - data
              example:
                code: 1
                message: Service succeed
                data:
                  total: 1
                  page_size: 20
                  records:
                    - channel: applovin
                      campaign: ''
                      ad_set: ''
                      ad_name: ''
                      new_lead_conversions: 0
                      conversions: 0
                      conversion_value: 0
                      new_order_conversion_value: 0
                      new_order_roas: 0
                      ad_net_conversion_value: 0
                      ad_net_roas: 0
                      spend: 22497.21
                      cpa: 0
                      roas: 0
                      impressions: 564551
                      cpm: 39.84
                      clicks: 0
                      cvr: 0
                      cpc: 0
                      ctr: 0
                      outbound_clicks: 0
                      outbound_ctr: 0
                      cost_per_outbound_click: 0
                      view_through_conversions: 0
                      view_through_conversion_value: 0
                      view_through_roas: 0
                      profit: -22497.21
                      margin: 0
          headers: {}
          x-apifox-name: Success
      security: []
      x-apifox-folder: Public API/Attribution/Ads
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/7934002/apis/api-427629971-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://data-api.test.attribuly.com
    description: test
  - url: https://data.api.attribuly.com
    description: prod
security: []

```
