# Get attribution report

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /{version}/api/all-attribution/get-list:
    post:
      summary: Get attribution report
      deprecated: false
      description: |-
        - Obtain a detailed attribution report
        - Rate limits: 5 requests per second.
        - version: v2-4-2.
      tags:
        - Public API/Attribution/All
      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.
                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.
                dimensions:
                  type: array
                  items:
                    type: string
                    description: |-
                      - campaign
                      - channel
                      - source
                      - medium
                      - landing_page
                  description: >-
                    The input quantity should not exceed 3,
                    campaign/channel/source/medium/landing_page.
                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: |-
                    - purchase 
                    - add_to_cart
                orders:
                  type: array
                  items:
                    type: object
                    properties:
                      column:
                        type: string
                        description: |-
                          - conversions
                          - new_lead_conversions
                          - conversion_value
                          - spend
                          - clicks
                          - ad_conversion_value
                          - impressions
                          - roas
                          - ad_roas
                          - cpa
                          - cpm
                          - cpc
                          - net_profit
                          - net_margin
                      order:
                        type: string
                        description: |-
                          - asc
                          - desc
                    x-apifox-orders:
                      - column
                      - order
                  description: the default order is conversions desc.
                page:
                  type: integer
                  description: page 1
                page_size:
                  type: integer
                  description: min:1,max:100.
              required:
                - start_date
                - end_date
                - dimensions
                - model
                - goal
                - page
                - page_size
              x-apifox-orders:
                - start_date
                - end_date
                - dimensions
                - model
                - goal
                - orders
                - page
                - page_size
            example:
              start_date: '2026-03-01'
              end_date: '2026-03-18'
              dimensions:
                - channel
              model: first
              goal: purchase
              orders:
                - column: conversions
                  order: desc
              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:
                            campaign:
                              type: string
                              description: campaign
                            channel:
                              type: string
                              description: channel
                            source:
                              type: string
                              description: source
                            platform:
                              type: string
                              description: platform
                            medium:
                              type: string
                              description: medium
                            landing_page:
                              type: string
                              description: conversions
                            conversions:
                              type: number
                              description: new lead conversions
                            new_lead_conversions:
                              type: number
                              description: conversion value
                            conversion_value:
                              type: number
                              description: spend
                            spend:
                              type: number
                              description: clicks
                            clicks:
                              type: number
                            ad_conversion_value:
                              type: number
                              description: ad conversion value
                            impressions:
                              type: number
                              description: impressions
                            roas:
                              type: number
                              description: roas
                            ad_roas:
                              type: number
                              description: ad roas
                            cpa:
                              type: number
                              description: cost per action
                            cpm:
                              type: number
                              description: cost per click
                            cpc:
                              type: number
                              description: cost per mille
                            net_profit:
                              type: number
                              description: net profit
                            net_margin:
                              type: number
                              description: net margin
                            ltv:
                              type: number
                              description: lifetime value
                          x-apifox-orders:
                            - campaign
                            - channel
                            - source
                            - platform
                            - medium
                            - landing_page
                            - conversions
                            - new_lead_conversions
                            - conversion_value
                            - spend
                            - clicks
                            - ad_conversion_value
                            - impressions
                            - roas
                            - ad_roas
                            - cpa
                            - cpm
                            - cpc
                            - net_profit
                            - net_margin
                            - ltv
                          required:
                            - conversions
                            - new_lead_conversions
                            - conversion_value
                            - spend
                            - clicks
                            - ad_conversion_value
                            - impressions
                            - roas
                            - ad_roas
                            - cpa
                            - cpm
                            - cpc
                            - net_profit
                            - net_margin
                            - ltv
                    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: succeed
                data:
                  total: 0
                  page_size: 0
                  records:
                    - campaign: test-campaign
                      channel: test-campaign
                      source: ''
                      platform: ''
                      medium: ''
                      landing_page: ''
                      conversions: 0
                      new_lead_conversions: 0
                      conversion_value: 0
                      spend: 0
                      clicks: 0
                      ad_conversion_value: 0
                      impressions: 0
                      roas: 0
                      ad_roas: 0
                      cpa: 0
                      cpm: 0
                      cpc: 0
                      net_profit: 0
                      net_margin: 0
                      ltv: 0
          headers: {}
          x-apifox-name: Success
      security: []
      x-apifox-folder: Public API/Attribution/All
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/7934002/apis/api-427629970-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://data-api.test.attribuly.com
    description: test
  - url: https://data.api.attribuly.com
    description: prod
security: []

```