openapi: 3.1.0
info:
  title: Brand API - Conversions
  description: |-
    API for submitting conversion events, such as sales, leads, or installs.
    A conversion, once attributed to a source, becomes an Action.
  version: v12
  x-gitbook-description-document:
    object: document
    data:
      schemaVersion: 9
    nodes:
      - object: block
        type: paragraph
        isVoid: false
        data: {}
        nodes:
          - object: text
            leaves:
              - object: leaf
                text: >-
                  API for submitting conversion events, such as sales, leads, or
                  installs. A conversion, once attributed to a source, becomes
                  an Action.
                marks: []
            key: HHicKAbYxHMW
        key: 5cWF2OJ68Uo3
    key: ftxKTcyVBInl
  x-gitbook-description-html: >-
    <p>API for submitting conversion events, such as sales, leads, or installs.
    A conversion, once attributed to a source, becomes an Action.</p>
servers:
  - url: https://api.impact.com
security:
  - basicAuth: []
paths:
  /Advertisers/{AccountSID}/Conversions:
    post:
      summary: Submit a Conversion
      description: >-
        Submits a conversion event for tracking and potential attribution.

        At a minimum, the request must include an event identifier
        (`EventTypeId` or `EventTypeCode`), an attribution key (like `ClickId`
        or `CustomerId`), `EventDate`, `CampaignId`, and `OrderId`.
      operationId: submitConversion
      tags:
        - Conversions
      parameters:
        - name: AccountSID
          in: path
          required: true
          schema:
            type: string
          description: Your unique Account SID.
          x-gitbook-description-html: <p>Your unique Account SID.</p>
      requestBody:
        description: >-
          The details of the conversion event. Use indexed parameters (e.g.,
          `ItemSku1`, `ItemSku2`) for multiple items.


          **Additional required parameters** not captured in the `required` list
          below:

          - One of `ActionTrackerId`, `EventTypeId`, or `EventTypeCode` is
          required (event identifier).

          - One of `ClickId`, `CustomerId`, `CustomProfileId`, `CustomClickId`,
          `PromoCode`, `MediaPartnerId`, `UniqueUrl`, `CallerId`, `GoogAId`,
          `AndroidId`, `AppleIfa`, or `AppleIfv` is required (attribution key).


          **Note on conditional requirements:** Many parameters listed below as
          *optional* are conditionally required based on what else you submit.
          For example:

          - Item-level fields (`ItemSku[i]`, `ItemQuantity[i]`, `ItemPrice[i]`,
          `ItemSubTotal[i]`, etc.) become required when reporting at the item
          level.

          - `CurrencyCode` is required when monetary fields are provided.

          - Mobile-app fields (`AppleIfa`, `GoogAId`, `AppPackage`,
          `AppInstallRef`, `PropertyId`) are required for mobile-app install
          attribution.

          - Call-tracking fields (`PhoneNumber`, `CallerId`, `CountryCode`) are
          required for call-tracking conversions.


          See each field's description for specific conditional requirements.
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - CampaignId
                - EventDate
                - OrderId
              properties:
                EventTypeId:
                  type: integer
                  description: Unique identifier for the event type (action tracker).
                  example: 8180
                  x-gitbook-description-html: >-
                    <p>Unique identifier for the event type (action
                    tracker).</p>
                EventTypeCode:
                  type: string
                  description: Configurable string code for the event type.
                  example: ACME_SALE
                  x-gitbook-description-html: <p>Configurable string code for the event type.</p>
                ClickId:
                  type: string
                  description: The impact.com generated click ID.
                  example: QiiWXOVnrQ3SQHl24jQjyxBGUkmzfJ3i1VHrWM0
                  x-gitbook-description-html: <p>The impact.com generated click ID.</p>
                CustomerId:
                  type: string
                  description: Your non-PII unique identifier for the customer.
                  example: BCZ2WVSH674563PDPYOTM3AXDQ
                  x-gitbook-description-html: <p>Your non-PII unique identifier for the customer.</p>
                CustomProfileId:
                  type: string
                  description: Your unique identifier for the website visitor.
                  example: a1b2c3d4e5f6
                  x-gitbook-description-html: <p>Your unique identifier for the website visitor.</p>
                OrderPromoCode:
                  type: string
                  description: Promo code used for the order.
                  example: 10OFF-ROCKET
                  x-gitbook-description-html: <p>Promo code used for the order.</p>
                UniqueUrl:
                  type: string
                  format: uri
                  description: A unique tracking URL assigned to a partner.
                  x-gitbook-description-html: <p>A unique tracking URL assigned to a partner.</p>
                GoogAId:
                  type: string
                  description: Google Advertising ID.
                  example: 38400000-8cf0-11bd-b23e-10b96e40000d
                  x-gitbook-description-html: <p>Google Advertising ID.</p>
                AppleIfa:
                  type: string
                  description: Apple ID for Advertising (IDFA).
                  example: 38400000-8cf0-11bd-b23e-10b96e40000d
                  x-gitbook-description-html: <p>Apple ID for Advertising (IDFA).</p>
                AppleIfv:
                  type: string
                  description: Apple ID for Vendors (IDFV).
                  example: 38400000-8cf0-11bd-b23e-10b96e40000d
                  x-gitbook-description-html: <p>Apple ID for Vendors (IDFV).</p>
                MediaId:
                  type: integer
                  description: Force attribution to a specific Partner ID.
                  example: 10000
                  x-gitbook-description-html: <p>Force attribution to a specific Partner ID.</p>
                PhoneNumber:
                  type: string
                  description: Phone number for call tracking attribution.
                  example: '8051234567'
                  x-gitbook-description-html: <p>Phone number for call tracking attribution.</p>
                CallerId:
                  type: string
                  description: Caller ID for call tracking attribution.
                  example: '8051234567'
                  x-gitbook-description-html: <p>Caller ID for call tracking attribution.</p>
                EventDate:
                  type: string
                  format: date-time
                  description: The date and time the conversion occurred (ISO 8601).
                  example: '2026-09-10T22:55:32-08:00'
                  x-gitbook-description-html: <p>The date and time the conversion occurred (ISO 8601).</p>
                CampaignId:
                  type: integer
                  description: The unique identifier for your program/campaign.
                  example: 3641
                  x-gitbook-description-html: <p>The unique identifier for your program/campaign.</p>
                OrderId:
                  type: string
                  description: Your unique identifier for the order.
                  example: '9217374917471'
                  x-gitbook-description-html: <p>Your unique identifier for the order.</p>
                OrderDiscount:
                  type: number
                  format: decimal
                  description: >-
                    For sales, this is the discount applied to the order
                    overall. Amount is automatically subtracted from the order
                    total on processing. If item amounts are used, this discount
                    will be subtracted proportionally from each item amount sent
                    in. Note that typically you will want to exclude shipping
                    discounts from this field.
                  example: 5
                  x-gitbook-description-html: >-
                    <p>For sales, this is the discount applied to the order
                    overall. Amount is automatically subtracted from the order
                    total on processing. If item amounts are used, this discount
                    will be subtracted proportionally from each item amount sent
                    in. Note that typically you will want to exclude shipping
                    discounts from this field.</p>
                OrderSubTotalPostDiscount:
                  type: number
                  format: decimal
                  description: >-
                    Used when reporting conversions at the order-level (i.e., no
                    item reporting). The subtotal of the order after discounts,
                    taxes, shipping, and any other costs. If you're submitting
                    item-level data, this value should not be submitted.
                  example: 95
                  x-gitbook-description-html: >-
                    <p>Used when reporting conversions at the order-level (i.e.,
                    no item reporting). The subtotal of the order after
                    discounts, taxes, shipping, and any other costs. If you're
                    submitting item-level data, this value should not be
                    submitted.</p>
                OrderShipping:
                  type: number
                  format: decimal
                  description: >-
                    Primarily used for retail sales. This is the cost of
                    shipping for this conversion. Note that the total sale
                    amount used for payout purposes will not include shipping
                    costs.
                  example: 5
                  x-gitbook-description-html: >-
                    <p>Primarily used for retail sales. This is the cost of
                    shipping for this conversion. Note that the total sale
                    amount used for payout purposes will not include shipping
                    costs.</p>
                OrderTax:
                  type: number
                  format: decimal
                  description: >-
                    Primarily used for retail sales. This is the cost of tax for
                    this conversion. Note that the total sale amount used for
                    payout purposes will not include shipping costs.
                  example: 8
                  x-gitbook-description-html: >-
                    <p>Primarily used for retail sales. This is the cost of tax
                    for this conversion. Note that the total sale amount used
                    for payout purposes will not include shipping costs.</p>
                OrderMargin:
                  type: number
                  format: decimal
                  description: >-
                    Primarily used for retail sales. This is the total margin
                    made on the conversion (revenue less costs). Typically this
                    is provided either at an item level through the ItemMargin
                    field or through the product catalog.
                  example: 30
                  x-gitbook-description-html: >-
                    <p>Primarily used for retail sales. This is the total margin
                    made on the conversion (revenue less costs). Typically this
                    is provided either at an item level through the ItemMargin
                    field or through the product catalog.</p>
                OrderDiscountRate:
                  type: number
                  format: decimal
                  description: The discount rate (%) applied to the order.
                  example: 10
                  x-gitbook-description-html: <p>The discount rate (%) applied to the order.</p>
                CurrencyCode:
                  type: string
                  description: 3-character ISO 4217 currency code of the purchase.
                  example: USD
                  x-gitbook-description-html: <p>3-character ISO 4217 currency code of the purchase.</p>
                Amount:
                  type: number
                  format: decimal
                  description: >-
                    This is the total order sale amount made on an item or order
                    level of the conversion.
                  example: 123
                  x-gitbook-description-html: >-
                    <p>This is the total order sale amount made on an item or
                    order level of the conversion.</p>
                GiftPurchase:
                  type: boolean
                  description: >-
                    If you're tracking gift purchases, you can submit true to
                    mark the order in the conversion as a gift purchase. Submit
                    false if the order isn't a gift purchase.
                  example: false
                  x-gitbook-description-html: >-
                    <p>If you're tracking gift purchases, you can submit true to
                    mark the order in the conversion as a gift purchase. Submit
                    false if the order isn't a gift purchase.</p>
                PaymentType:
                  type: string
                  description: >-
                    This method of payment used for this conversion (e.g.
                    Credit).
                  example: CREDIT_CARD
                  x-gitbook-description-html: >-
                    <p>This method of payment used for this conversion (e.g.
                    Credit).</p>
                ItemSku[i]:
                  type: string
                  description: SKU for the item (e.g., ItemSku1, ItemSku2).
                  x-gitbook-description-html: <p>SKU for the item (e.g., ItemSku1, ItemSku2).</p>
                ItemPromoCode[i]:
                  type: string
                  description: >-
                    Promotional code applied to the item for the order. Note
                    that this parameter does not work with unique tracking codes
                    setup for particular partners.
                  example: 10OFF-ACME
                  x-gitbook-description-html: >-
                    <p>Promotional code applied to the item for the order. Note
                    that this parameter does not work with unique tracking codes
                    setup for particular partners.</p>
                ItemName[i]:
                  type: string
                  description: >-
                    The name for the product referenced. Can also be
                    automatically appended through uploading a product catalog.
                  x-gitbook-description-html: >-
                    <p>The name for the product referenced. Can also be
                    automatically appended through uploading a product
                    catalog.</p>
                ItemCategory[i]:
                  type: string
                  description: Category of the item.
                  x-gitbook-description-html: <p>Category of the item.</p>
                ItemSubCategory[i]:
                  type: string
                  description: >-
                    If applicable, the subcategory for the product referenced at
                    the item level. Can also be automatically pulled if a
                    product catalog has been uploaded.
                  example: Tennis
                  x-gitbook-description-html: >-
                    <p>If applicable, the subcategory for the product referenced
                    at the item level. Can also be automatically pulled if a
                    product catalog has been uploaded.</p>
                ItemMpn[i]:
                  type: string
                  description: >-
                    Manufacturer part number (MPN) for the product referenced.
                    Can also be automatically pulled if a product catalog has
                    been uploaded.
                  example: ACME-MPN-101
                  x-gitbook-description-html: >-
                    <p>Manufacturer part number (MPN) for the product
                    referenced. Can also be automatically pulled if a product
                    catalog has been uploaded.</p>
                ItemBrand[i]:
                  type: string
                  description: >-
                    Brand name for the product referenced. Can also be
                    automatically pulled if a product catalog has been uploaded.
                  example: Acme
                  x-gitbook-description-html: >-
                    <p>Brand name for the product referenced. Can also be
                    automatically pulled if a product catalog has been
                    uploaded.</p>
                ItemPrice[i]:
                  type: number
                  format: decimal
                  description: >-
                    Unit price for the item. Do not send if ItemSubTotal[i] is
                    passed.
                  x-gitbook-description-html: >-
                    <p>Unit price for the item. Do not send if ItemSubTotal[i]
                    is passed.</p>
                ItemSubTotal[i]:
                  type: number
                  format: decimal
                  description: >-
                    Total price for the line item. Do not send if `ItemPrice[i]`
                    is passed.
                  x-gitbook-description-html: >-
                    <p>Total price for the line item. Do not send if
                    <code>ItemPrice[i]</code> is passed.</p>
                ItemQuantity[i]:
                  type: integer
                  description: Number of units for this line item.
                  x-gitbook-description-html: <p>Number of units for this line item.</p>
                ItemDiscount[i]:
                  type: number
                  format: decimal
                  description: >-
                    Discount applied to each item purchased of this type (not to
                    the entire line item).
                  example: 1
                  x-gitbook-description-html: >-
                    <p>Discount applied to each item purchased of this type (not
                    to the entire line item).</p>
                ItemDiscountRate[i]:
                  type: number
                  format: decimal
                  description: The discount rate (%) applied to each item purchased.
                  example: 10
                  x-gitbook-description-html: <p>The discount rate (%) applied to each item purchased.</p>
                ItemTotalDiscount[i]:
                  type: number
                  format: decimal
                  description: >-
                    Discount applied to this line item (not just for each
                    product of this type). Note that this amount is
                    automatically subtracted from the ItemSubTotal to determine
                    the final sale amount for payout and reporting purposes.
                  example: 5
                  x-gitbook-description-html: >-
                    <p>Discount applied to this line item (not just for each
                    product of this type). Note that this amount is
                    automatically subtracted from the ItemSubTotal to determine
                    the final sale amount for payout and reporting purposes.</p>
                ItemDeliveryType[i]:
                  type: string
                  description: >-
                    Type of delivery method specified for this item (e.g.
                    INSTORE).
                  example: INSTORE
                  x-gitbook-description-html: >-
                    <p>Type of delivery method specified for this item (e.g.
                    INSTORE).</p>
                CustomerEmail:
                  type: string
                  description: Customer's email address (plain text or SHA1 hashed).
                  example: customer@gmail.com
                  x-gitbook-description-html: <p>Customer's email address (plain text or SHA1 hashed).</p>
                CustomerStatus:
                  type: string
                  description: >-
                    Status of the customer, such as NEW or EXISTING. Before
                    being passed, values must be configured in the Customer
                    Status Mapping section when editing an event type, found in
                    the event type settings section of the platform.
                  example: NEW
                  x-gitbook-description-html: >-
                    <p>Status of the customer, such as NEW or EXISTING. Before
                    being passed, values must be configured in the Customer
                    Status Mapping section when editing an event type, found in
                    the event type settings section of the platform.</p>
                CustomerCity:
                  type: string
                  description: City of the customer, such as Santa Barbara.
                  x-gitbook-description-html: <p>City of the customer, such as Santa Barbara.</p>
                CustomerRegion:
                  type: string
                  description: Region of the customer, such as AMER.
                  x-gitbook-description-html: <p>Region of the customer, such as AMER.</p>
                CustomerCountry:
                  type: string
                  description: Country of the customer, such as USA.
                  x-gitbook-description-html: <p>Country of the customer, such as USA.</p>
                CustomerPostCode:
                  type: string
                  description: Postal (or "ZIP") code of the customer, such as 93101.
                  x-gitbook-description-html: >-
                    <p>Postal (or "ZIP") code of the customer, such as
                    93101.</p>
                IpAddress:
                  type: string
                  description: >-
                    Customer's IP address. Used for fraud detection and install
                    attribution.
                  example: 72.194.216.61
                  x-gitbook-description-html: >-
                    <p>Customer's IP address. Used for fraud detection and
                    install attribution.</p>
                UserAgent:
                  type: string
                  description: >-
                    User agent of the customer, used to provide device
                    reporting.
                  example: >-
                    Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
                    AppleWebKit/537.36
                  x-gitbook-description-html: >-
                    <p>User agent of the customer, used to provide device
                    reporting.</p>
                DeviceMfr:
                  type: string
                  description: >-
                    Mobile device's manufacturer. Pass
                    `android.os.Build.MANUFACTURER` on Android or `"Apple"` on
                    iOS.
                  example: Apple
                  x-gitbook-description-html: >-
                    <p>Mobile device's manufacturer. Pass
                    <code>android.os.Build.MANUFACTURER</code> on Android or
                    <code>"Apple"</code> on iOS.</p>
                DeviceModel:
                  type: string
                  description: >-
                    Mobile device's model. Pass `android.os.Build.MODEL` on
                    Android or the value from `systemInfo.machine` on iOS.
                  example: iPhone 15
                  x-gitbook-description-html: >-
                    <p>Mobile device's model. Pass
                    <code>android.os.Build.MODEL</code> on Android or the value
                    from <code>systemInfo.machine</code> on iOS.</p>
                PropertyId:
                  type: integer
                  description: >-
                    For mobile app conversions, this value is the "System App
                    ID" of your app in impact.com. Found in Settings → Mobile
                    Apps.
                  example: 12345
                  x-gitbook-description-html: >-
                    <p>For mobile app conversions, this value is the "System App
                    ID" of your app in impact.com. Found in Settings → Mobile
                    Apps.</p>
                AppPackage:
                  type: string
                  description: >-
                    Package name for the mobile app the user installed. Only for
                    mobile conversions. Note that this is also picked up through
                    the PropertyId field.
                  example: com.acme.app
                  x-gitbook-description-html: >-
                    <p>Package name for the mobile app the user installed. Only
                    for mobile conversions. Note that this is also picked up
                    through the PropertyId field.</p>
                AppInstallRef:
                  type: string
                  description: >-
                    Only for Android conversions. Install referrer passed from
                    the Google Play Store when the app is installed. Usually,
                    the value passed from impact.com tracking links will be
                    clickid={clickidvalue}.
                  example: clickid=QiiWXOVnrQ3SQHl24jQjyxBGUkmzfJ3i1VHrWM0
                  x-gitbook-description-html: >-
                    <p>Only for Android conversions. Install referrer passed
                    from the Google Play Store when the app is installed.
                    Usually, the value passed from impact.com tracking links
                    will be clickid={clickidvalue}.</p>
                AppVer:
                  type: string
                  description: Version of the mobile app. Only for mobile conversions.
                  example: 1.2.3
                  x-gitbook-description-html: >-
                    <p>Version of the mobile app. Only for mobile
                    conversions.</p>
                LocationId:
                  type: string
                  description: >-
                    Primarily used for accommodations, this is the unique
                    identifier for the location specified in this conversion.
                  example: LOC-12345
                  x-gitbook-description-html: >-
                    <p>Primarily used for accommodations, this is the unique
                    identifier for the location specified in this
                    conversion.</p>
                LocationName:
                  type: string
                  description: >-
                    Primarily used for accommodations, this is the name for the
                    location specified in this conversion.
                  example: Acme Resort Santa Barbara
                  x-gitbook-description-html: >-
                    <p>Primarily used for accommodations, this is the name for
                    the location specified in this conversion.</p>
                LocationType:
                  type: string
                  description: >-
                    Primarily used for accommodations, this is the category for
                    the location specified in this conversion.
                  example: HOTEL
                  x-gitbook-description-html: >-
                    <p>Primarily used for accommodations, this is the category
                    for the location specified in this conversion.</p>
                TrackingConsent:
                  type: boolean
                  description: >-
                    Indicates whether the user has provided consent to be
                    tracked at the moment of the request. Derived from your
                    consent management platform or through frameworks like
                    Apple's ATT (App Tracking Transparency) available on iOS.
                  example: true
                  x-gitbook-description-html: >-
                    <p>Indicates whether the user has provided consent to be
                    tracked at the moment of the request. Derived from your
                    consent management platform or through frameworks like
                    Apple's ATT (App Tracking Transparency) available on
                    iOS.</p>
                Note:
                  type: string
                  description: >-
                    General field used to pass information for event-level
                    reporting purposes.
                  example: Customer confirmed delivery.
                  x-gitbook-description-html: >-
                    <p>General field used to pass information for event-level
                    reporting purposes.</p>
                DispositionCode:
                  type: string
                  description: >-
                    If you have a custom disposition code configured in event
                    type settings, you can submit that value as a default
                    disposition for the action that results from this
                    conversion.
                  example: DEFAULT
                  x-gitbook-description-html: >-
                    <p>If you have a custom disposition code configured in event
                    type settings, you can submit that value as a default
                    disposition for the action that results from this
                    conversion.</p>
                Text1–Text50:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data you
                    want to send. Appears in your reports. There are 50 of these
                    fields, from Text1 to Text50.
                  example: text1value
                Numeric1:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 100.5
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric2:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 20
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric3:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 30
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric4:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 40
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric5:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 50
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric6:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 60
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric7:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 70
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric8:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 80
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric9:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 90
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Numeric10:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.
                  example: 100
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data you want to send. Appears in your reports.</p>
                Money1:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any money or
                    financial data you want to send. Appears in your reports.
                  example: 50
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any money
                    or financial data you want to send. Appears in your
                    reports.</p>
                Money2:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any money or
                    financial data you want to send. Appears in your reports.
                  example: 50
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any money
                    or financial data you want to send. Appears in your
                    reports.</p>
                Money3:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any money or
                    financial data you want to send. Appears in your reports.
                  example: 75
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any money
                    or financial data you want to send. Appears in your
                    reports.</p>
                Date1:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date2:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date3:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date4:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date5:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date6:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date7:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date8:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date9:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                Date10:
                  type: string
                  description: >-
                    Field that accepts a date string, for example "2026-03-28",
                    or a datetime string, for example "2026-05-21T07:25:00Z".
                    Appears in your reports.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>Field that accepts a date string, for example
                    "2026-03-28", or a datetime string, for example
                    "2026-05-21T07:25:00Z". Appears in your reports.</p>
                ItemText[i]_1:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-1
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_2:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-2
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_3:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-3
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_4:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-4
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_5:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-5
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_6:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-6
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_7:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-7
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_8:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-8
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_9:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-9
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemText[i]_10:
                  type: string
                  description: >-
                    General text field that accepts strings of any text data for
                    a SKU.
                  example: item-text-10
                  x-gitbook-description-html: >-
                    <p>General text field that accepts strings of any text data
                    for a SKU.</p>
                ItemNumeric[i]_1:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 5
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_2:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 10
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_3:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 15
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_4:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 20
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_5:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 25
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_6:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 30
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_7:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 35
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_8:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 40
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_9:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 45
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemNumeric[i]_10:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any numeric
                    data for a SKU.
                  example: 50
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any numeric
                    data for a SKU.</p>
                ItemMoney[i]_1:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any money or
                    financial data for a SKU.
                  example: 10
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any money
                    or financial data for a SKU.</p>
                ItemMoney[i]_2:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any money or
                    financial data for a SKU.
                  example: 20
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any money
                    or financial data for a SKU.</p>
                ItemMoney[i]_3:
                  type: number
                  description: >-
                    General numeral field that accepts strings of any money or
                    financial data for a SKU.
                  example: 30
                  x-gitbook-description-html: >-
                    <p>General numeral field that accepts strings of any money
                    or financial data for a SKU.</p>
                ItemDate[i]_1:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_2:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_3:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_4:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_5:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_6:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_7:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_8:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_9:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-03-28'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
                ItemDate[i]_10:
                  type: string
                  description: >-
                    General date field that accepts a date or datetime for a
                    SKU.
                  example: '2026-05-21T07:25:00Z'
                  x-gitbook-description-html: >-
                    <p>General date field that accepts a date or datetime for a
                    SKU.</p>
        x-gitbook-description-html: >-
          <p>The details of the conversion event. Use indexed parameters (e.g.,
          <code>ItemSku1</code>, <code>ItemSku2</code>) for multiple items.</p>

          <p><strong>Additional required parameters</strong> not captured in the
          <code>required</code> list below:</p>

          <ul>

          <li>One of <code>ActionTrackerId</code>, <code>EventTypeId</code>, or
          <code>EventTypeCode</code> is required (event identifier).</li>

          <li>One of <code>ClickId</code>, <code>CustomerId</code>,
          <code>CustomProfileId</code>, <code>CustomClickId</code>,
          <code>PromoCode</code>, <code>MediaPartnerId</code>,
          <code>UniqueUrl</code>, <code>CallerId</code>, <code>GoogAId</code>,
          <code>AndroidId</code>, <code>AppleIfa</code>, or
          <code>AppleIfv</code> is required (attribution key).</li>

          </ul>

          <p><strong>Note on conditional requirements:</strong> Many parameters
          listed below as <em>optional</em> are conditionally required based on
          what else you submit. For example:</p>

          <ul>

          <li>Item-level fields (<code>ItemSku[i]</code>,
          <code>ItemQuantity[i]</code>, <code>ItemPrice[i]</code>,
          <code>ItemSubTotal[i]</code>, etc.) become required when reporting at
          the item level.</li>

          <li><code>CurrencyCode</code> is required when monetary fields are
          provided.</li>

          <li>Mobile-app fields (<code>AppleIfa</code>, <code>GoogAId</code>,
          <code>AppPackage</code>, <code>AppInstallRef</code>,
          <code>PropertyId</code>) are required for mobile-app install
          attribution.</li>

          <li>Call-tracking fields (<code>PhoneNumber</code>,
          <code>CallerId</code>, <code>CountryCode</code>) are required for
          call-tracking conversions.</li>

          </ul>

          <p>See each field's description for specific conditional
          requirements.</p>
      responses:
        '200':
          description: The conversion event was successfully queued for processing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    example: QUEUED
                  QueuedUri:
                    type: string
                    format: uri-reference
                    example: /Advertisers/<AccountSID>/APISubmissions/<SubmissionID>
          x-gitbook-description-html: <p>The conversion event was successfully queued for processing.</p>
        '400':
          description: >-
            Bad Request. The request was invalid due to missing or malformed
            parameters.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    example: ERROR
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        level:
                          type: string
                          example: ERROR
                        message:
                          type: string
          x-gitbook-description-html: >-
            <p>Bad Request. The request was invalid due to missing or malformed
            parameters.</p>
      x-codeSamples:
        - lang: cURL
          source: |-
            curl -L \
              --request POST \
              --url 'https://api.impact.com/Advertisers/{AccountSID}/Conversions' \
              --user '{AccountSID}:{AuthToken}' \
              --header 'Content-Type: application/x-www-form-urlencoded' \
              --header 'Accept: */*'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Submits a conversion event for tracking and potential
                      attribution. At a minimum, the request must include an
                      event identifier (
                    marks: []
                  - object: leaf
                    text: EventTypeId
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' or '
                    marks: []
                  - object: leaf
                    text: EventTypeCode
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: '), an attribution key (like '
                    marks: []
                  - object: leaf
                    text: ClickId
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' or '
                    marks: []
                  - object: leaf
                    text: CustomerId
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: '), '
                    marks: []
                  - object: leaf
                    text: EventDate
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ', '
                    marks: []
                  - object: leaf
                    text: CampaignId
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ', and '
                    marks: []
                  - object: leaf
                    text: OrderId
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: 0UPpbbEZheiN
            key: vIMcpZfgY26I
        key: ci9qJ7r2p58j
      x-gitbook-description-html: >-
        <p>Submits a conversion event for tracking and potential attribution. At
        a minimum, the request must include an event identifier
        (<code>EventTypeId</code> or <code>EventTypeCode</code>), an attribution
        key (like <code>ClickId</code> or <code>CustomerId</code>),
        <code>EventDate</code>, <code>CampaignId</code>, and
        <code>OrderId</code>.</p>
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use your AccountSID as the username and AuthToken as the password.
      x-gitbook-description-html: >-
        <p>Use your AccountSID as the username and AuthToken as the
        password.</p>
x-default-client: cURL
