openapi: 3.0.3
info:
  title: Everflow Network API - Conversion Reporting
  description: >
    Conversion reporting and management endpoints for the Everflow partner marketing
    platform. Search, retrieve, update, and create conversions.
    For more detail, see [Conversion Report](https://helpdesk.everflow.io/customer/conversion-report) in the Help Center.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
tags:
  - name: Reporting
    description: Conversion reporting and management endpoints.
paths:
  /networks/reporting/conversions:
    patch:
      summary: Update Conversion Status
      tags:
        - Reporting
      requestBody:
        content:
          application/json:
            example:
              conversion_ids:
                - "9c0534c99eb34b57bda16f92b6d5d3d4"
                - "307971a211b74db98c3c11d5e83c082a"
                - "5759e555b03845279bcdb9c2d0391b9e"
              conversion_status: "rejected"
            schema:
              type: object
              required:
                - conversion_ids
                - conversion_status
              properties:
                conversion_ids:
                  items:
                    type: string
                  nullable: true
                  type: array
                  description: IDs of the conversions to update.
                conversion_status:
                  type: string
                  description: Target status for the conversions.
                  enum:
                    - approved
                    - rejected
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: boolean
                type: object
          description: ""
      security:
        - API Key: []
    post:
      summary: Get Conversion Report
      tags:
        - Reporting
      parameters:
        - in: query
          name: page
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: The page of results to retrieve.
        - in: query
          name: page_size
          required: false
          schema:
            type: integer
            minimum: 1
            default: 50
          description: The number of results to return per page.
      requestBody:
        content:
          application/json:
            example:
              show_conversions: true
              show_events: false
              from: "2026-03-01"
              to: "2026-03-31"
              timezone_id: 67
              currency_id: "USD"
              query:
                filters: []
                search_terms: []
            schema:
              required:
                - from
                - to
                - timezone_id
                - show_conversions
                - show_events
              properties:
                currency_id:
                  type: string
                from:
                  type: string
                query:
                  properties:
                    filters:
                      properties:
                        filter_id_value:
                          type: string
                        resource_type:
                          enum:
                            - offer
                            - offer_group
                            - affiliate
                            - advertiser
                            - offer_creative
                            - transaction_id
                            - campaign
                            - billing_frequency
                            - business_unit
                            - label
                            - category
                            - sub1
                            - sub2
                            - sub3
                            - sub4
                            - sub5
                            - sub6
                            - sub7
                            - sub8
                            - sub9
                            - sub10
                            - source_id
                            - country
                            - account_manager
                            - affiliate_manager
                            - status
                            - offer_url
                            - currency_id
                            - affiliate_tier
                            - adv1
                            - adv2
                            - adv3
                            - adv4
                            - adv5
                            - adv6
                            - adv7
                            - adv8
                            - adv9
                            - adv10
                            - browser
                            - carrier
                            - city
                            - coupon_code
                            - dma
                            - date
                            - hourly
                            - device_brand
                            - device_type
                            - hour
                            - isp
                            - language
                            - month
                            - os_version
                            - payout_amount
                            - payout_type
                            - platform
                            - project_id
                            - referrer
                            - region
                            - revenue_amount
                            - revenue_type
                            - week
                            - conversion_id
                            - order_id
                            - tracking_domain
                            - offer_payout_revenue_id
                            - country_code
                            - advertiser_billing_frequency
                            - error_code
                          type: string
                      type: object
                    search_terms:
                      properties:
                        search_type:
                          enum:
                            - transaction_id
                            - sub_1
                            - sub_2
                            - sub_3
                            - sub_4
                            - sub_5
                            - adv_1
                            - adv_2
                            - adv_3
                            - adv_4
                            - adv_5
                            - source_id
                            - user_ip
                            - user_agent
                            - order_id
                            - country
                            - region
                            - city
                            - status
                            - is_scrub
                            - email
                            - coupon_code
                            - event_name
                          type: string
                        value:
                          type: string
                      type: object
                  type: object
                show_conversions:
                  type: boolean
                show_events:
                  type: boolean
                show_only_ct:
                  type: boolean
                show_only_fail_traffic:
                  type: boolean
                show_only_scrub:
                  type: boolean
                show_only_vt:
                  type: boolean
                timezone_id:
                  type: integer
                to:
                  type: string
              type: object
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  conversions:
                    type: array
                    items:
                      type: object
                      properties:
                        adv1:
                          type: string
                        adv2:
                          type: string
                        adv3:
                          type: string
                        adv4:
                          type: string
                        adv5:
                          type: string
                        adv6:
                          type: string
                        adv7:
                          type: string
                        adv8:
                          type: string
                        adv9:
                          type: string
                        adv10:
                          type: string
                        android_id:
                          type: string
                        android_id_md5:
                          type: string
                        android_id_sha1:
                          type: string
                        app_id:
                          type: string
                        brand:
                          type: string
                        browser:
                          type: string
                        carrier:
                          type: string
                        city:
                          type: string
                        click_unix_timestamp:
                          type: integer
                        conversion_id:
                          type: string
                        conversion_unix_timestamp:
                          type: integer
                        conversion_user_ip:
                          type: string
                        country:
                          type: string
                        coupon_code:
                          type: string
                        currency_id:
                          type: string
                        device_model:
                          type: string
                        device_type:
                          type: string
                        dma:
                          type: integer
                        email:
                          type: string
                        error_code:
                          type: integer
                        error_message:
                          type: string
                        event:
                          type: string
                        google_ad_id:
                          type: string
                        google_ad_id_md5:
                          type: string
                        google_ad_id_sha1:
                          type: string
                        http_user_agent:
                          type: string
                        idfa:
                          type: string
                        idfa_md5:
                          type: string
                        idfa_sha1:
                          type: string
                        is_event:
                          type: boolean
                        is_scrub:
                          type: boolean
                        is_view_through:
                          type: boolean
                        isp:
                          type: string
                        language:
                          type: string
                        network_offer_payout_revenue_id:
                          type: integer
                        notes:
                          type: string
                        order_id:
                          type: string
                        os_version:
                          type: string
                        payout:
                          type: number
                        payout_type:
                          type: string
                        platform:
                          type: string
                        previous_network_offer_id:
                          type: integer
                        referer:
                          type: string
                        region:
                          type: string
                        relationship:
                          properties:
                            account_manager:
                              properties:
                                account_status:
                                  enum:
                                    - active
                                    - inactive
                                    - suspended
                                    - pending
                                  type: string
                                first_name:
                                  type: string
                                full_name:
                                  type: string
                                last_name:
                                  type: string
                                network_employee_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            adv_global_event:
                              properties:
                                advertiser_id:
                                  type: integer
                                entry_name:
                                  type: string
                                network_advertiser_global_event_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            advertiser:
                              properties:
                                account_status:
                                  enum:
                                    - active
                                    - inactive
                                    - pending
                                    - suspended
                                  type: string
                                name:
                                  type: string
                                network_advertiser_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            affiliate:
                              properties:
                                account_status:
                                  enum:
                                    - active
                                    - inactive
                                    - pending
                                    - suspended
                                  type: string
                                name:
                                  type: string
                                network_affiliate_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            affiliate_manager:
                              properties:
                                account_status:
                                  enum:
                                    - active
                                    - inactive
                                    - suspended
                                    - pending
                                  type: string
                                first_name:
                                  type: string
                                full_name:
                                  type: string
                                last_name:
                                  type: string
                                network_employee_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            affiliate_tier:
                              properties:
                                name:
                                  type: string
                                network_affiliate_tier_id:
                                  type: integer
                                network_id:
                                  type: integer
                                status:
                                  enum:
                                    - active
                                    - paused
                                    - deleted
                                  type: string
                              type: object
                            attribution_method:
                              enum:
                                - cookie
                                - transaction_id
                                - coupon_code
                                - email
                                - fingerprinting
                                - manual_upload
                                - clickless
                                - skad
                                - csv_upload
                                - webhook
                                - integration
                                - user_management
                              type: string
                            campaign:
                              properties:
                                campaign_name:
                                  type: string
                                campaign_status:
                                  enum:
                                    - active
                                    - paused
                                    - deleted
                                  type: string
                                network_campaign_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            candidate_clicks:
                              properties:
                                relationship:
                                  properties:
                                    affiliate:
                                      properties:
                                        account_status:
                                          enum:
                                            - active
                                            - inactive
                                            - pending
                                            - suspended
                                          type: string
                                        name:
                                          type: string
                                        network_affiliate_id:
                                          type: integer
                                        network_id:
                                          type: integer
                                      type: object
                                  type: object
                                transaction_id:
                                  type: string
                                unix_timestamp:
                                  type: integer
                              type: object
                            click_attribution_method:
                              type: string
                            conversion_referer:
                              type: string
                            custom_payout_revenue:
                              properties:
                                name:
                                  type: string
                                network_custom_payout_revenue_setting_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            events_count:
                              type: integer
                            is_enforce_caps:
                              type: boolean
                            line_items_custom_payout_revenue_settings:
                              properties:
                                name:
                                  type: string
                                network_custom_payout_revenue_setting_id:
                                  type: integer
                                network_id:
                                  type: integer
                              type: object
                            offer:
                              properties:
                                name:
                                  type: string
                                network_id:
                                  type: integer
                                network_offer_id:
                                  type: integer
                                offer_status:
                                  enum:
                                    - active
                                    - paused
                                    - pending
                                    - deleted
                                  type: string
                              type: object
                            offer_group:
                              properties:
                                name:
                                  type: string
                                network_advertiser_id:
                                  type: integer
                                network_id:
                                  type: integer
                                network_offer_group_id:
                                  type: integer
                                offer_count:
                                  type: integer
                                offer_group_status:
                                  enum:
                                    - active
                                    - paused
                                    - deleted
                                  type: string
                              type: object
                            offer_url:
                              properties:
                                name:
                                  type: string
                                network_id:
                                  type: integer
                                network_offer_id:
                                  type: integer
                                network_offer_url_id:
                                  type: integer
                              type: object
                            on_hold_snapshots:
                              properties:
                                initiator:
                                  enum:
                                    - manual
                                    - conversion_processing
                                    - conversion_update
                                    - csv
                                  type: string
                                network_employee:
                                  properties:
                                    account_status:
                                      enum:
                                        - active
                                        - inactive
                                        - suspended
                                        - pending
                                      type: string
                                    first_name:
                                      type: string
                                    full_name:
                                      type: string
                                    last_name:
                                      type: string
                                    network_employee_id:
                                      type: integer
                                    network_id:
                                      type: integer
                                  type: object
                                network_id:
                                  type: integer
                                on_hold_conversion_history_snapshot_id:
                                  type: integer
                                on_hold_conversion_id:
                                  type: string
                                snapshot_type:
                                  enum:
                                    - status
                                    - payout_revenue
                                  type: string
                                status:
                                  enum:
                                    - on_hold
                                    - approved
                                    - rejected
                                  type: string
                                unix_timestamp:
                                  type: integer
                              type: object
                            order_line_items:
                              properties:
                                discount:
                                  type: number
                                name:
                                  type: string
                                network_order_line_item_id:
                                  type: integer
                                order_id:
                                  type: integer
                                order_number:
                                  type: integer
                                price:
                                  type: number
                                product_id:
                                  type: integer
                                quantity:
                                  type: integer
                                sku:
                                  type: string
                              type: object
                            postback_control:
                              properties:
                                name:
                                  type: string
                                network_id:
                                  type: integer
                                network_postback_control_id:
                                  type: integer
                              type: object
                            redirect_url:
                              type: string
                            referer:
                              type: string
                            snapshots:
                              properties:
                                conversion_history_snapshot_id:
                                  type: integer
                                conversion_id:
                                  type: string
                                error_code:
                                  type: integer
                                initiator:
                                  enum:
                                    - manual
                                    - csv
                                    - bulk_payout_adjustment
                                    - twenty_four_metrics
                                    - reversal
                                    - avow
                                    - retroactive_tiered_commission
                                  type: string
                                network_employee:
                                  properties:
                                    account_status:
                                      enum:
                                        - active
                                        - inactive
                                        - suspended
                                        - pending
                                      type: string
                                    first_name:
                                      type: string
                                    full_name:
                                      type: string
                                    last_name:
                                      type: string
                                    network_employee_id:
                                      type: integer
                                    network_id:
                                      type: integer
                                  type: object
                                network_id:
                                  type: integer
                                payout:
                                  type: number
                                revenue:
                                  type: number
                                sale_amount:
                                  type: number
                                snapshot_type:
                                  enum:
                                    - status
                                    - payout_revenue
                                    - sale_amount
                                    - payout_revenue_and_sale_amount
                                  type: string
                                status:
                                  enum:
                                    - approved
                                    - rejected
                                    - pending
                                    - invalid
                                  type: string
                                unix_timestamp:
                                  type: integer
                              type: object
                            tiered_commission:
                              properties:
                                name:
                                  type: string
                                network_id:
                                  type: integer
                                network_tiered_commission_id:
                                  type: integer
                              type: object
                            unix_timestamp_postback:
                              type: integer
                            usm_data:
                              nullable: true
                              description: User session management data. Null when not applicable.
                              type: object
                            query_parameters:
                              type: object
                              description: The query string parameters from the original click URL.
                          type: object
                        revenue:
                          type: number
                        revenue_type:
                          type: string
                        sale_amount:
                          type: number
                        session_user_ip:
                          type: string
                        source_id:
                          type: string
                        status:
                          enum:
                            - approved
                            - rejected
                            - pending
                            - invalid
                          type: string
                        sub1:
                          type: string
                        sub2:
                          type: string
                        sub3:
                          type: string
                        sub4:
                          type: string
                        sub5:
                          type: string
                        sub6:
                          type: string
                        sub7:
                          type: string
                        sub8:
                          type: string
                        sub9:
                          type: string
                        sub10:
                          type: string
                        transaction_id:
                          type: string
                        url:
                          type: string
                  paging:
                    properties:
                      page:
                        type: integer
                      page_size:
                        type: integer
                      total_count:
                        type: integer
                    type: object
                type: object
          description: ""
      security:
        - API Key: []
  /networks/reporting/conversions/summary:
    post:
      summary: Get Conversion Summary
      tags:
        - Reporting
      requestBody:
        required: true
        content:
          application/json:
            example:
              from: "2026-03-01"
              to: "2026-03-08"
              timezone_id: 90
              currency_id: "USD"
              show_conversions: true
              show_events: true
            schema:
              type: object
              required:
                - from
                - to
                - timezone_id
                - currency_id
                - show_conversions
                - show_events
              properties:
                from:
                  type: string
                  description: Start date. Format `YYYY-MM-DD` or `YYYY-MM-DD HH:mm:SS`.
                to:
                  type: string
                  description: End date. Format `YYYY-MM-DD` or `YYYY-MM-DD HH:mm:SS`.
                timezone_id:
                  type: integer
                  description: Timezone identifier for the request.
                currency_id:
                  type: string
                  description: Currency code for monetary values. Currently only `USD` is supported.
                show_conversions:
                  type: boolean
                  description: Include base conversions in the summary. At least one of `show_conversions` or `show_events` must be `true`.
                show_events:
                  type: boolean
                  description: Include post-conversion events in the summary. At least one of `show_conversions` or `show_events` must be `true`.
                show_only_scrub:
                  type: boolean
                  description: When `true`, only include scrubbed conversions/events in the summary.
                query:
                  type: object
                  description: Optional query filters to narrow the summary scope.
                  properties:
                    filters:
                      type: array
                      description: >
                        Filters to narrow results. Same resource_type filters use OR
                        logic; different resource_type filters use AND logic.
                      items:
                        type: object
                        required:
                          - filter_id_value
                          - resource_type
                        properties:
                          filter_id_value:
                            type: string
                            description: The value to filter on.
                          resource_type:
                            type: string
                            enum:
                              - offer
                              - offer_group
                              - affiliate
                              - advertiser
                              - offer_creative
                              - transaction_id
                              - campaign
                              - billing_frequency
                              - business_unit
                              - label
                              - category
                              - sub1
                              - sub2
                              - sub3
                              - sub4
                              - sub5
                              - sub6
                              - sub7
                              - sub8
                              - sub9
                              - sub10
                              - source_id
                              - country
                              - account_manager
                              - affiliate_manager
                              - status
                              - sales_manager
                              - account_executive
                              - offer_url
                              - currency_id
                              - affiliate_tier
                              - adv1
                              - adv2
                              - adv3
                              - adv4
                              - adv5
                              - adv6
                              - adv7
                              - adv8
                              - adv9
                              - adv10
                              - browser
                              - carrier
                              - city
                              - coupon_code
                              - dma
                              - date
                              - hourly
                              - device_brand
                              - device_type
                              - hour
                              - isp
                              - language
                              - month
                              - os_version
                              - payout_amount
                              - payout_type
                              - platform
                              - project_id
                              - referrer
                              - region
                              - revenue_amount
                              - revenue_type
                              - week
                              - conversion_id
                              - order_id
                              - tracking_domain
                              - offer_payout_revenue_id
                              - country_code
                              - advertiser_billing_frequency
                              - error_code
                            description: The resource type / dimension to filter on.
                    search_terms:
                      type: array
                      description: Text-based search filters.
                      items:
                        type: object
                        properties:
                          search_type:
                            type: string
                            enum:
                              - transaction_id
                              - sub_1
                              - sub_2
                              - sub_3
                              - sub_4
                              - sub_5
                              - adv_1
                              - adv_2
                              - adv_3
                              - adv_4
                              - adv_5
                              - source_id
                              - user_ip
                              - user_agent
                              - order_id
                              - country
                              - region
                              - city
                              - status
                              - is_scrub
                              - email
                              - coupon_code
                              - event_name
                            description: The field to search on.
                          value:
                            type: string
                            description: The search value.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Total number of conversions/events matching the query.
                  pending:
                    type: integer
                    description: Number of conversions/events with pending status.
                  approved:
                    type: integer
                    description: Number of approved conversions/events.
                  invalid:
                    type: integer
                    description: Number of invalid conversions/events.
                  rejected_scrub:
                    type: integer
                    description: Number of conversions/events rejected by scrub rules.
                  rejected_manual:
                    type: integer
                    description: Number of manually rejected conversions/events.
                  payout:
                    type: number
                    format: double
                    description: Total payout amount.
                  revenue:
                    type: number
                    format: double
                    description: Total revenue amount.
                  gross_sales:
                    type: number
                    format: double
                    description: Total gross sales amount.
                  has_multi_currencies:
                    type: boolean
                    description: Indicates whether the result set includes conversions in multiple currencies.
                  avg_click_to_cv_time:
                    type: number
                    format: double
                    description: Average time in seconds between the click and the conversion.
      security:
        - API Key: []
  /networks/reporting/conversions/{conversionId}:
    get:
      summary: Get Conversion by ID
      tags:
        - Reporting
      parameters:
        - in: path
          name: conversionId
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  adv1:
                    type: string
                  adv2:
                    type: string
                  adv3:
                    type: string
                  adv4:
                    type: string
                  adv5:
                    type: string
                  adv6:
                    type: string
                  adv7:
                    type: string
                  adv8:
                    type: string
                  adv9:
                    type: string
                  adv10:
                    type: string
                  android_id:
                    type: string
                  android_id_md5:
                    type: string
                  android_id_sha1:
                    type: string
                  app_id:
                    type: string
                  brand:
                    type: string
                  browser:
                    type: string
                  carrier:
                    type: string
                  city:
                    type: string
                  click_unix_timestamp:
                    type: integer
                  conversion_id:
                    type: string
                  conversion_unix_timestamp:
                    type: integer
                  conversion_user_ip:
                    type: string
                  country:
                    type: string
                  coupon_code:
                    type: string
                  currency_id:
                    type: string
                  device_model:
                    type: string
                  device_type:
                    type: string
                  dma:
                    type: integer
                  email:
                    type: string
                  error_code:
                    type: integer
                  error_message:
                    type: string
                  event:
                    type: string
                  google_ad_id:
                    type: string
                  google_ad_id_md5:
                    type: string
                  google_ad_id_sha1:
                    type: string
                  http_user_agent:
                    type: string
                  idfa:
                    type: string
                  idfa_md5:
                    type: string
                  idfa_sha1:
                    type: string
                  is_event:
                    type: boolean
                  is_scrub:
                    type: boolean
                  is_view_through:
                    type: boolean
                  isp:
                    type: string
                  language:
                    type: string
                  network_offer_payout_revenue_id:
                    type: integer
                  notes:
                    type: string
                  order_id:
                    type: string
                  os_version:
                    type: string
                  payout:
                    type: number
                  payout_type:
                    type: string
                  platform:
                    type: string
                  previous_network_offer_id:
                    type: integer
                  referer:
                    type: string
                  region:
                    type: string
                  relationship:
                    properties:
                      account_manager:
                        properties:
                          account_status:
                            enum:
                              - active
                              - inactive
                              - suspended
                              - pending
                            type: string
                          first_name:
                            type: string
                          full_name:
                            type: string
                          last_name:
                            type: string
                          network_employee_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      adv_global_event:
                        properties:
                          advertiser_id:
                            type: integer
                          entry_name:
                            type: string
                          network_advertiser_global_event_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      advertiser:
                        properties:
                          account_status:
                            enum:
                              - active
                              - inactive
                              - pending
                              - suspended
                            type: string
                          name:
                            type: string
                          network_advertiser_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      affiliate:
                        properties:
                          account_status:
                            enum:
                              - active
                              - inactive
                              - pending
                              - suspended
                            type: string
                          name:
                            type: string
                          network_affiliate_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      affiliate_manager:
                        properties:
                          account_status:
                            enum:
                              - active
                              - inactive
                              - suspended
                              - pending
                            type: string
                          first_name:
                            type: string
                          full_name:
                            type: string
                          last_name:
                            type: string
                          network_employee_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      affiliate_tier:
                        properties:
                          name:
                            type: string
                          network_affiliate_tier_id:
                            type: integer
                          network_id:
                            type: integer
                          status:
                            enum:
                              - active
                              - paused
                              - deleted
                            type: string
                        type: object
                      attribution_method:
                        enum:
                          - cookie
                          - transaction_id
                          - coupon_code
                          - email
                          - fingerprinting
                          - manual_upload
                          - clickless
                          - skad
                          - csv_upload
                          - webhook
                          - integration
                          - user_management
                        type: string
                      campaign:
                        properties:
                          campaign_name:
                            type: string
                          campaign_status:
                            enum:
                              - active
                              - paused
                              - deleted
                            type: string
                          network_campaign_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      candidate_clicks:
                        properties:
                          relationship:
                            properties:
                              affiliate:
                                properties:
                                  account_status:
                                    enum:
                                      - active
                                      - inactive
                                      - pending
                                      - suspended
                                    type: string
                                  name:
                                    type: string
                                  network_affiliate_id:
                                    type: integer
                                  network_id:
                                    type: integer
                                type: object
                            type: object
                          transaction_id:
                            type: string
                          unix_timestamp:
                            type: integer
                        type: object
                      click_attribution_method:
                        type: string
                      conversion_referer:
                        type: string
                      custom_payout_revenue:
                        properties:
                          name:
                            type: string
                          network_custom_payout_revenue_setting_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      events_count:
                        type: integer
                      is_enforce_caps:
                        type: boolean
                      line_items_custom_payout_revenue_settings:
                        properties:
                          name:
                            type: string
                          network_custom_payout_revenue_setting_id:
                            type: integer
                          network_id:
                            type: integer
                        type: object
                      offer:
                        properties:
                          name:
                            type: string
                          network_id:
                            type: integer
                          network_offer_id:
                            type: integer
                          offer_status:
                            enum:
                              - active
                              - paused
                              - pending
                              - deleted
                            type: string
                        type: object
                      offer_group:
                        properties:
                          name:
                            type: string
                          network_advertiser_id:
                            type: integer
                          network_id:
                            type: integer
                          network_offer_group_id:
                            type: integer
                          offer_count:
                            type: integer
                          offer_group_status:
                            enum:
                              - active
                              - paused
                              - deleted
                            type: string
                        type: object
                      offer_url:
                        properties:
                          name:
                            type: string
                          network_id:
                            type: integer
                          network_offer_id:
                            type: integer
                          network_offer_url_id:
                            type: integer
                        type: object
                      on_hold_snapshots:
                        properties:
                          initiator:
                            enum:
                              - manual
                              - conversion_processing
                              - conversion_update
                              - csv
                            type: string
                          network_employee:
                            properties:
                              account_status:
                                enum:
                                  - active
                                  - inactive
                                  - suspended
                                  - pending
                                type: string
                              first_name:
                                type: string
                              full_name:
                                type: string
                              last_name:
                                type: string
                              network_employee_id:
                                type: integer
                              network_id:
                                type: integer
                            type: object
                          network_id:
                            type: integer
                          on_hold_conversion_history_snapshot_id:
                            type: integer
                          on_hold_conversion_id:
                            type: string
                          snapshot_type:
                            enum:
                              - status
                              - payout_revenue
                            type: string
                          status:
                            enum:
                              - on_hold
                              - approved
                              - rejected
                            type: string
                          unix_timestamp:
                            type: integer
                        type: object
                      order_line_items:
                        properties:
                          discount:
                            type: number
                          name:
                            type: string
                          network_order_line_item_id:
                            type: integer
                          order_id:
                            type: integer
                          order_number:
                            type: integer
                          price:
                            type: number
                          product_id:
                            type: integer
                          quantity:
                            type: integer
                          sku:
                            type: string
                        type: object
                      postback_control:
                        properties:
                          name:
                            type: string
                          network_id:
                            type: integer
                          network_postback_control_id:
                            type: integer
                        type: object
                      redirect_url:
                        type: string
                      referer:
                        type: string
                      snapshots:
                        properties:
                          conversion_history_snapshot_id:
                            type: integer
                          conversion_id:
                            type: string
                          error_code:
                            type: integer
                          initiator:
                            enum:
                              - manual
                              - csv
                              - bulk_payout_adjustment
                              - twenty_four_metrics
                              - reversal
                              - avow
                              - retroactive_tiered_commission
                            type: string
                          network_employee:
                            properties:
                              account_status:
                                enum:
                                  - active
                                  - inactive
                                  - suspended
                                  - pending
                                type: string
                              first_name:
                                type: string
                              full_name:
                                type: string
                              last_name:
                                type: string
                              network_employee_id:
                                type: integer
                              network_id:
                                type: integer
                            type: object
                          network_id:
                            type: integer
                          payout:
                            type: number
                          revenue:
                            type: number
                          sale_amount:
                            type: number
                          snapshot_type:
                            enum:
                              - status
                              - payout_revenue
                              - sale_amount
                              - payout_revenue_and_sale_amount
                            type: string
                          status:
                            enum:
                              - approved
                              - rejected
                              - pending
                              - invalid
                            type: string
                          unix_timestamp:
                            type: integer
                        type: object
                      tiered_commission:
                        properties:
                          name:
                            type: string
                          network_id:
                            type: integer
                          network_tiered_commission_id:
                            type: integer
                        type: object
                      unix_timestamp_postback:
                        type: integer
                      usm_data:
                        nullable: true
                        description: User session management data. Null when not applicable.
                        type: object
                      query_parameters:
                        type: object
                        description: The query string parameters from the original click URL.
                    type: object
                  revenue:
                    type: number
                  revenue_type:
                    type: string
                  sale_amount:
                    type: number
                  session_user_ip:
                    type: string
                  source_id:
                    type: string
                  status:
                    enum:
                      - approved
                      - rejected
                      - pending
                      - invalid
                    type: string
                  sub1:
                    type: string
                  sub2:
                    type: string
                  sub3:
                    type: string
                  sub4:
                    type: string
                  sub5:
                    type: string
                  sub6:
                    type: string
                  sub7:
                    type: string
                  sub8:
                    type: string
                  sub9:
                    type: string
                  sub10:
                    type: string
                  transaction_id:
                    type: string
                  url:
                    type: string
                type: object
          description: ""
      security:
        - API Key: []
  /networks/reporting/conversions/{conversionId}/payoutrevenue:
    put:
      summary: Update Conversion Payout and Revenue
      tags:
        - Reporting
      parameters:
        - in: path
          name: conversionId
          required: true
          schema:
            type: string
          description: The conversion ID to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - payout
                - revenue
              properties:
                payout:
                  type: number
                  minimum: 0
                  description: Partner payout amount. Must be greater than or equal to 0.
                revenue:
                  type: number
                  minimum: 0
                  description: Revenue amount. Must be greater than or equal to 0.
                is_event:
                  type: boolean
                  description: >
                    Whether the conversion being updated is a post-conversion
                    event. Set to `true` when updating an event, `false` (or
                    omit) for a base conversion.
              type: object
            example:
              is_event: true
              payout: 10
              revenue: 0
      responses:
        "200":
          content:
            application/json:
              example:
                result: true
              schema:
                properties:
                  result:
                    type: boolean
                    description: Whether the operation was accepted.
                type: object
          description: ""
      security:
        - API Key: []
  /networks/reporting/conversions/email:
    post:
      summary: Search Conversions by Email
      tags:
        - Reporting
      requestBody:
        required: true
        content:
          application/json:
            example:
              email: "customer@example.com"
              from: "2025-01-01"
              to: "2025-01-31"
              timezone_id: 67
            schema:
              type: object
              required:
                - email
                - from
                - to
                - timezone_id
              properties:
                email:
                  type: string
                  description: Email address to search for.
                from:
                  type: string
                  description: "Start date (format: YYYY-MM-DD)."
                to:
                  type: string
                  description: "End date (format: YYYY-MM-DD)."
                timezone_id:
                  type: integer
                  description: Timezone ID for the report.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  conversions:
                    type: array
                    items:
                      type: object
                      properties:
                        conversion_id:
                          type: string
                        conversion_unix_timestamp:
                          type: integer
                        sub1:
                          type: string
                        sub2:
                          type: string
                        sub3:
                          type: string
                        sub4:
                          type: string
                        sub5:
                          type: string
                        sub6:
                          type: string
                        sub7:
                          type: string
                        sub8:
                          type: string
                        sub9:
                          type: string
                        sub10:
                          type: string
                        source_id:
                          type: string
                        status:
                          type: string
                          enum:
                            - approved
                            - rejected
                            - pending
                            - invalid
                        payout_type:
                          type: string
                        revenue_type:
                          type: string
                        payout:
                          type: number
                        revenue:
                          type: number
                        session_user_ip:
                          type: string
                        conversion_user_ip:
                          type: string
                        country:
                          type: string
                        region:
                          type: string
                        city:
                          type: string
                        dma:
                          type: integer
                        carrier:
                          type: string
                        platform:
                          type: string
                        os_version:
                          type: string
                        device_type:
                          type: string
                        device_model:
                          type: string
                        brand:
                          type: string
                        browser:
                          type: string
                        language:
                          type: string
                        http_user_agent:
                          type: string
                        adv1:
                          type: string
                        adv2:
                          type: string
                        adv3:
                          type: string
                        adv4:
                          type: string
                        adv5:
                          type: string
                        adv6:
                          type: string
                        adv7:
                          type: string
                        adv8:
                          type: string
                        adv9:
                          type: string
                        adv10:
                          type: string
                        is_event:
                          type: boolean
                        event:
                          type: string
                        notes:
                          type: string
                        transaction_id:
                          type: string
                        click_unix_timestamp:
                          type: integer
                        error_code:
                          type: integer
                        error_message:
                          type: string
                        sale_amount:
                          type: number
                        is_scrub:
                          type: boolean
                        coupon_code:
                          type: string
                        order_id:
                          type: string
                        url:
                          type: string
                        isp:
                          type: string
                        referer:
                          type: string
                        app_id:
                          type: string
                        idfa:
                          type: string
                        idfa_md5:
                          type: string
                        idfa_sha1:
                          type: string
                        google_ad_id:
                          type: string
                        google_ad_id_md5:
                          type: string
                        google_ad_id_sha1:
                          type: string
                        android_id:
                          type: string
                        android_id_md5:
                          type: string
                        android_id_sha1:
                          type: string
                        currency_id:
                          type: string
                        email:
                          type: string
                        is_view_through:
                          type: boolean
                        previous_network_offer_id:
                          type: integer
                        network_offer_payout_revenue_id:
                          type: integer
                        relationship:
                          type: object
                          properties:
                            offer:
                              type: object
                              properties:
                                network_offer_id:
                                  type: integer
                                network_id:
                                  type: integer
                                name:
                                  type: string
                                offer_status:
                                  type: string
                                  enum:
                                    - active
                                    - paused
                                    - pending
                                    - deleted
                            advertiser:
                              type: object
                              properties:
                                network_advertiser_id:
                                  type: integer
                                network_id:
                                  type: integer
                                name:
                                  type: string
                                account_status:
                                  type: string
                            account_manager:
                              type: object
                              properties:
                                network_employee_id:
                                  type: integer
                                network_id:
                                  type: integer
                                first_name:
                                  type: string
                                last_name:
                                  type: string
                                full_name:
                                  type: string
                                account_status:
                                  type: string
                            affiliate:
                              type: object
                              properties:
                                network_affiliate_id:
                                  type: integer
                                network_id:
                                  type: integer
                                name:
                                  type: string
                                account_status:
                                  type: string
                            affiliate_manager:
                              type: object
                              properties:
                                network_employee_id:
                                  type: integer
                                network_id:
                                  type: integer
                                first_name:
                                  type: string
                                last_name:
                                  type: string
                                full_name:
                                  type: string
                                account_status:
                                  type: string
                            offer_group:
                              type: object
                              properties:
                                network_offer_group_id:
                                  type: integer
                                network_id:
                                  type: integer
                                network_advertiser_id:
                                  type: integer
                                name:
                                  type: string
                                offer_group_status:
                                  type: string
                                offer_count:
                                  type: integer
                            attribution_method:
                              type: string
                            query_parameters:
                              type: object
                              description: The query string parameters from the original click URL.
                            usm_data:
                              nullable: true
                              type: object
                              description: User session management data. Null when not applicable.
                            order_line_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  network_order_line_item_id:
                                    type: integer
                                  order_id:
                                    type: integer
                                  order_number:
                                    type: integer
                                  product_id:
                                    type: integer
                                  sku:
                                    type: string
                                  name:
                                    type: string
                                  quantity:
                                    type: integer
                                  price:
                                    type: number
                                  discount:
                                    type: number
      security:
        - API Key: []

  /networks/reporting/conversions/{transactionId}:
    patch:
      summary: Update Conversion Status by Transaction ID
      description: >
        Modify the status of all conversions and events linked to a single
        transaction ID. Only `approved` and `rejected` are accepted values.
        Conversions that are `invalid` will be ignored; only `approved`,
        `rejected`, and `pending` conversions will be updated.


        Note that the endpoint is asynchronous. Even when the endpoint returns
        `true` immediately, it may take up to a few seconds for the conversion
        updates to be processed (and to fire partner pixels if appropriate).
      tags:
        - Reporting
      parameters:
        - in: path
          name: transactionId
          required: true
          schema:
            type: string
          description: The transaction ID whose conversions should be updated.
      requestBody:
        required: true
        content:
          application/json:
            example:
              conversion_status: "approved"
            schema:
              type: object
              required:
                - conversion_status
              properties:
                conversion_status:
                  type: string
                  enum:
                    - approved
                    - rejected
                  description: Target status for the conversions.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                    description: Whether the update was successful.
      security:
        - API Key: []

  /networks/reporting/conversions/{conversionId}/notes:
    put:
      summary: Update Conversion Notes
      tags:
        - Reporting
      parameters:
        - in: path
          name: conversionId
          required: true
          schema:
            type: string
          description: The conversion ID to update.
      requestBody:
        required: true
        content:
          application/json:
            example:
              notes: "Verified with advertiser — approved manually"
            schema:
              type: object
              required:
                - notes
              properties:
                notes:
                  type: string
                  description: >
                    Free-form notes attached to the conversion. Visible to network
                    users in the Everflow UI and returned on subsequent reads of
                    the conversion record. Pass an empty string to clear existing
                    notes.
      responses:
        "200":
          description: The updated conversion record.
          content:
            application/json:
              schema:
                type: object
                description: >
                  The full conversion record after the update — same shape as
                  the [Get Conversion By ID](/api-reference/get-networksreportingconversionsbyid)
                  response. The `notes` field reflects the value that was just set.
                properties:
                  conversion_id:
                    type: string
                    description: Unique conversion identifier.
                  notes:
                    type: string
                    description: The updated notes value.
                  conversion_unix_timestamp:
                    type: integer
                    description: Unix timestamp of the conversion (UTC seconds).
                  status:
                    type: string
                    description: Conversion status (e.g. `approved`, `pending`, `rejected`).
                  is_event:
                    type: boolean
                    description: Whether this record is a post-conversion event.
                  payout:
                    type: number
                    description: Partner payout amount.
                  revenue:
                    type: number
                    description: Revenue amount.
                  sale_amount:
                    type: number
                    description: Sale amount (if applicable).
                  transaction_id:
                    type: string
                    description: Associated click transaction ID.
                  relationship:
                    type: object
                    description: Related objects (offer, advertiser, affiliate, account_manager, campaign, etc.).
      security:
        - API Key: []

  /networks/reporting/conversions/{conversionId}/saleamount:
    put:
      summary: Update Conversion Sale Amount
      tags:
        - Reporting
      parameters:
        - in: path
          name: conversionId
          required: true
          schema:
            type: string
          description: The conversion ID to update.
      requestBody:
        required: true
        content:
          application/json:
            example:
              sale_amount: 0.01
              is_event: true
            schema:
              type: object
              required:
                - sale_amount
              properties:
                sale_amount:
                  type: number
                  minimum: 0
                  description: The new sale amount. Must be greater than or equal to 0.
                is_event:
                  type: boolean
                  description: >
                    Whether the conversion being updated is a post-conversion
                    event. Set to `true` when updating an event, `false` (or
                    omit) for a base conversion.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                    description: Whether the update was successful.
      security:
        - API Key: []

  /networks/conversions/reporting/transaction_ids:
    post:
      summary: Create Conversions with Transaction IDs
      tags:
        - Conversion Updates
      requestBody:
        required: true
        content:
          application/json:
            example:
              is_now: true
              offer_id: 33
              timezone_id: 90
              event_id: 0
              revenue_amount: 2
              is_payout_amount_submitted: false
              is_revenue_amount_submitted: true
              transaction_ids:
                - "300b69de1ba44b5fb84ac4c013436511"
                - "300b69de1ba44b5fb84ac4c013436512"
                - "300b69de1ba44b5fb84ac4c013436513"
            schema:
              type: object
              required:
                - offer_id
                - event_id
                - transaction_ids
                - timezone_id
                - is_now
              properties:
                offer_id:
                  type: integer
                  description: The offer ID under which the conversions will be created.
                event_id:
                  type: integer
                  description: >
                    The offer event ID. Use `0` for the default base conversion
                    event.
                transaction_ids:
                  type: array
                  items:
                    type: string
                  description: >
                    List of transaction IDs to create conversions for. Each
                    transaction ID must match a click belonging to the specified
                    offer.
                timezone_id:
                  type: integer
                  description: >
                    Timezone ID for the conversions. Can be found using the
                    [metadata API](/api-reference/get-metatimezones).
                is_now:
                  type: boolean
                  description: >
                    When `true`, conversions are recorded as of now. When
                    `false`, you must provide a `date` value.
                date:
                  type: string
                  description: >
                    Specific date and time for the conversions when `is_now` is
                    `false`. Format: `YYYY-MM-DD HH:mm:ss`.
                internal_notes:
                  type: string
                  description: Internal notes attached to each conversion. Not visible to affiliates.
                revenue_amount:
                  type: number
                  description: Revenue amount per conversion.
                is_revenue_amount_submitted:
                  type: boolean
                  description: >
                    Whether the `revenue_amount` value should be applied. Must
                    be `true` for the `revenue_amount` to take effect.
                payout_amount:
                  type: number
                  description: Payout amount per conversion.
                is_payout_amount_submitted:
                  type: boolean
                  description: >
                    Whether the `payout_amount` value should be applied. Must
                    be `true` for the `payout_amount` to take effect.
                sale_amount:
                  type: number
                  description: Sale amount value per conversion.
                adv1:
                  type: string
                  description: Advertiser sub-parameter 1.
                adv2:
                  type: string
                  description: Advertiser sub-parameter 2.
                adv3:
                  type: string
                  description: Advertiser sub-parameter 3.
                adv4:
                  type: string
                  description: Advertiser sub-parameter 4.
                adv5:
                  type: string
                  description: Advertiser sub-parameter 5.
                adv6:
                  type: string
                  description: Advertiser sub-parameter 6.
                adv7:
                  type: string
                  description: Advertiser sub-parameter 7.
                adv8:
                  type: string
                  description: Advertiser sub-parameter 8.
                adv9:
                  type: string
                  description: Advertiser sub-parameter 9.
                adv10:
                  type: string
                  description: Advertiser sub-parameter 10.
                email:
                  type: string
                  description: Email value to attach to each conversion.
                coupon_code:
                  type: string
                  description: Coupon code value to attach to each conversion.
                order_id:
                  type: string
                  description: Order ID value to attach to each conversion.
                user_id:
                  type: string
                  description: >
                    Your own user or customer identifier to attach to each
                    conversion. Surrounding whitespace is trimmed, and an empty
                    value is ignored.
      responses:
        "200":
          description: ""
          content:
            application/json:
              example:
                result: true
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                    description: Whether the conversions were created successfully.
      security:
        - API Key: []

  /networks/conversions/reporting:
    post:
      summary: Create Conversions without Transaction IDs
      tags:
        - Conversion Updates
      requestBody:
        required: true
        content:
          application/json:
            example:
              is_now: true
              offer_id: 33
              affiliate_id: 39
              timezone_id: 90
              event_id: 0
              number_of_conversions: 2
              order_id: "321312"
            schema:
              type: object
              required:
                - offer_id
                - event_id
                - affiliate_id
                - number_of_conversions
                - timezone_id
                - is_now
              properties:
                offer_id:
                  type: integer
                  description: The offer ID under which the conversions will be created.
                event_id:
                  type: integer
                  description: >
                    The offer event ID. Use `0` for the default base conversion
                    event.
                affiliate_id:
                  type: integer
                  description: The affiliate (partner) ID for the conversions.
                number_of_conversions:
                  type: integer
                  minimum: 1
                  maximum: 50
                  description: Number of conversions to create (between 1 and 50).
                timezone_id:
                  type: integer
                  description: >
                    Timezone ID for the conversions. Can be found using the
                    [metadata API](/api-reference/get-metatimezones).
                is_now:
                  type: boolean
                  description: >
                    When `true`, conversions are recorded as of now. When
                    `false`, you must provide a `date` value.
                date:
                  type: string
                  description: >
                    Specific date and time for the conversions when `is_now` is
                    `false`. Format: `YYYY-MM-DD HH:mm:ss`.
                internal_notes:
                  type: string
                  description: Internal notes attached to each conversion. Not visible to affiliates.
                revenue_amount:
                  type: number
                  description: Revenue amount per conversion.
                is_revenue_amount_submitted:
                  type: boolean
                  description: >
                    Whether the `revenue_amount` value should be applied. Must
                    be `true` for the `revenue_amount` to take effect.
                payout_amount:
                  type: number
                  description: Payout amount per conversion.
                is_payout_amount_submitted:
                  type: boolean
                  description: >
                    Whether the `payout_amount` value should be applied. Must
                    be `true` for the `payout_amount` to take effect.
                sale_amount:
                  type: number
                  description: Sale amount value per conversion.
                adv1:
                  type: string
                  description: Advertiser sub-parameter 1.
                adv2:
                  type: string
                  description: Advertiser sub-parameter 2.
                adv3:
                  type: string
                  description: Advertiser sub-parameter 3.
                adv4:
                  type: string
                  description: Advertiser sub-parameter 4.
                adv5:
                  type: string
                  description: Advertiser sub-parameter 5.
                adv6:
                  type: string
                  description: Advertiser sub-parameter 6.
                adv7:
                  type: string
                  description: Advertiser sub-parameter 7.
                adv8:
                  type: string
                  description: Advertiser sub-parameter 8.
                adv9:
                  type: string
                  description: Advertiser sub-parameter 9.
                adv10:
                  type: string
                  description: Advertiser sub-parameter 10.
                email:
                  type: string
                  description: Email value to attach to each conversion.
                coupon_code:
                  type: string
                  description: Coupon code value to attach to each conversion.
                order_id:
                  type: string
                  description: Order ID value to attach to each conversion.
                user_id:
                  type: string
                  description: >
                    Your own user or customer identifier to attach to each
                    conversion. Surrounding whitespace is trimmed, and an empty
                    value is ignored.
      responses:
        "200":
          description: ""
          content:
            application/json:
              example:
                result: true
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                    description: Whether the conversions were created successfully.
      security:
        - API Key: []

  /networks/reporting/upload/conversions:
    post:
      summary: Upload Conversions CSV
      tags:
        - Reporting
      requestBody:
        required: true
        content:
          application/json:
            example:
              file:
                temp_url: "https://usercontent.everflowclient.io/123/temp/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
                original_file_name: "conversions_jan_2026.csv"
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: object
                  description: File reference for the CSV upload.
                  properties:
                    temp_url:
                      type: string
                      description: >
                        Temporary URL returned by the Upload Temp File endpoint.
                        Format: `https://usercontent.everflowclient.io/<network_id>/temp/<guid>`
                    original_file_name:
                      type: string
                      description: Original name of the CSV file.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                description: Upload result with processing status.
      security:
        - API Key: []

  /networks/reporting/upload/conversions/table:
    post:
      summary: List Conversion Uploads
      tags:
        - Reporting
      parameters:
        - in: query
          name: page
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: The page of results to retrieve.
        - in: query
          name: page_size
          required: false
          schema:
            type: integer
            minimum: 1
            default: 50
          description: The number of results to return per page.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                search_terms:
                  type: array
                  items:
                    type: object
                  description: Text search filters.
                filters:
                  type: object
                  description: Structured filters to narrow results.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  entries:
                    type: array
                    items:
                      type: object
                      description: Conversion upload record.
                  paging:
                    type: object
                    properties:
                      page:
                        type: integer
                      page_size:
                        type: integer
                      total_count:
                        type: integer
      security:
        - API Key: []

  /networks/reporting/upload/conversions/{uploadId}:
    get:
      summary: Get Conversion Upload by ID
      tags:
        - Reporting
      parameters:
        - in: path
          name: uploadId
          required: true
          schema:
            type: integer
          description: The conversion upload ID.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                description: Conversion upload record with processing details.
      security:
        - API Key: []

components:
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey
