Skip to main content

Conversions API

The Conversions API allows you to create and manage conversions to track user traffic for ad campaigns.

This page covers the common endpoints and methods associated with the Conversions API. The IQM platform supports three types of conversions:

  • Pixel conversions are client-side tracking and they feature advanced settings for fine-tuned optimization.
  • Postback conversions use server-to-server tracking, sending conversion data directly from your server to IQM without relying on browser-based JavaScript or cookies.
  • Universal Pixel conversions are client-side and use a single JavaScript snippet that can track multiple conversion events across your site without deploying separate per-page pixels.

More resources​

Authentication​

Use the following header parameters for all requests:

Headers
Authentication
string required		Authentication bearer token.
See Sign up and authenticate.
X-IAA-OW-ID
integer required		Organization Workspace ID header.

Get conversion details​

Postback conversion resource properties​

Resource properties
id
integer		Postback conversion ID.
name
string		Postback conversion name.
uuid
string		Universally unique identifier.
typeId
integer		Conversion type ID.
Supported values
1Pixel
2Postback
3Universal Pixel
owId
integer		Organization Workspace ID.
createdByUowId
integer		Created by Organization Workspace User ID.
modifiedByUowId
integer		Modified by Organization Workspace User ID.
statusId
integer		Status ID.
Supported values
1Active
2Pending
partnerTypeId
integer		Partner type ID.
Supported values
1Kochava
2Singular
3Appsflyer
4Adjust
impressionUrl
string		Impression URL.
clickUrl
string		Click URL.

Pixel conversion resource properties​

Resource properties
id
integer		Pixel conversion ID.
uuid
string		Universally unique identifier.
typeId
integer		Conversion type ID.
Supported values
1Pixel
2Postback
3Universal Pixel
owId
integer		Organization Workspace ID.
createdByUowId
integer		Created by Organization Workspace User ID.
modifiedByUowId
integer		Modified by Organization Workspace User ID.
statusId
integer		Status ID.
Supported values
1Active
2Pending
created
integer		Unix epoch timestamp of Pixel conversion creation, in milliseconds.
name
string		Name for Pixel conversion.
attributionId
string		Attribution type ID.
Supported values
1Hybrid
2Click based
3View based
customFields
string		Allows user to pass additional data along with conversion details, which can be used for more detailed Insights.
financialMetrics
string		Allows user to pass additional financial data along with conversion details, which can then be used to calculate ROAs.
piggybackData
object		Piggyback data details.
piggybackData object properties
url
string		Additional URL that can be added to a Pixel conversion to send conversion information to a third-party platform.
type
integer		Piggyback type ID.
Supported values
1Image Pixel
2Javascript Pixel
pixelConversionScript
string		Pixel conversion script.
conversionSetting
object		Advanced conversion settings.
conversionSetting object properties
conversionDuration
object		Determines the length of time after a user clicks or views (or both: hybrid) an ad that a conversion can be attributed to that ad.
conversionDuration object properties
view
integer		View-based attribution gives credit to an ad that a user saw, but did not necessarily interact with, before making a conversion.
Post view interval, days: [1...30].
click
integer		Click-based attribution assigns credit for a conversion to the last ad that a user clicked on before making a purchase or taking an action.
Post click interval, days: [7...60].
repeatConversion
object		Allows for multiple conversions from the same user to be tracked and attributed to the same ad or campaign.
repeatConversion object properties
count
integer		Counts all conversions per user [0] or just 1 conversion per user [1].
frequency
integer		Counts 1 conversion per user for specified number based on selected unit.
unit
string		Selected unit of conversion frequency.
crossModelling
boolean		Machine learning technique used to attribute conversion to ads that may not have received direct clicks or views from the same device.

Get conversion details by ID​

GET

Get details about a conversion from its ID.

Path parameter
conversionId
integer		Conversion ID.
Query parameter
typeId
integer		Conversion type ID for which the details will be returned.
Supported values
1Pixel
2Postback
3Universal Pixel

{
  "success": true,
  "data": {
    "id": 3121,
    "name": "PixelConversion",
    "uuid": "7e955ccbb92340f7b28c744eb876c9c6",
    "typeId": 1,
    "owId": 202017,
    "createdByUowId": 12121,
    "modifiedByUowId": 12121,
    "attributionId": 1,
    "statusId": 1,
    "customFields": [
      "field_1",
      "field_2",
      "field_3"
    ],
    "financialMetrics": "field_1",
    "piggybackData": {
        "url": "http://thisPiggybackUrl.com/piggy",
        "type": 1
    },
    "pixelConversionScript": "<script src='https://pxl.stage.iqm.com/i/pixel/7e955ccbb92340f7b28c744eb876c9c6?cv={CONVERSION_VALUE}' async></script>",
    "conversionSetting": {
      "conversionDuration": {
        "view": 10,
        "click": 10
      },
      "repeatConversion": {
        "count": 1,
        "frequency": 1,
        "unit": "Day"
      },
      "crossModelling": true
    }
  }
}
{
  "success": true,
  "data": {
    "id": 3109,
    "name": "Postback Conversion",
    "uuid": "fb75a80c7b254234b910399f34be5482",
    "typeId": 2,
    "owId": 202017,
    "createdByUowId": 108658,
    "modifiedByUowId": 108658,
    "statusId": 0,
    "partnerTypeId": 1,
    "impressionUrl": "https://imp.control.kochava.com/track/impression?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603",
    "clickUrl": "https://imp.control.kochava.com/track/impression?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603"
  }
}

Get list of conversions​

GET

Get a list of conversions with details and filters.

A conversion id can be used to Get conversion details by ID and to perform various actions in Conversions management endpoints.

Query parameters
searchField
string		Filter results by search field.
limit
integer		Number of entries returned per page, default: 20.
pageNo
integer		Page number of retrieved data, default: 1.
sortBy
string		Sorts by ascending (+) or descending (-), default: -created.
conversionsId
string		Conversion ID.
typeIds
string		Filters by conversion type ID.
Supported values
1Pixel
2Postback
3Universal Pixel
statusIds
string		Filters by conversion status ID.
Supported values
1Active
2Pending
postbackPartnerIds
string		Postback partner IDs.
Supported values
1Kochava
2Singular
3Appsflyer
4Adjust
Response properties
id
integer		Conversion ID.
name
string		Conversion name.
postbackPartnerName
string		Postback partner name.
status
string		Conversion status.
type
string		Conversion type.
created
integer		Unix epoch creation date, in milliseconds.
totalConversions
integer		Total conversions count.
owID
integer		Organization Workspace ID.
createdByUowId
integer		Created by User Organization Workspace ID.
modifiedByUowId
integer		Modified by User Organization Workspace ID.
uuid
integer		Universally unique identifier.
pixelConversionScript
string		Pixel conversion script.
attributedConversion
integer		The number of conversions that are attributed to a specific campaign based on the Attribution model.
attributedViewThroughConversion
integer		The number of conversions that occurred after a user viewed an ad but did not click on it.
attributedClickThroughConversion
integer		The number of conversions that occurred after a user clicked on an ad.
pixelFinancialMetric
string		Pixel financial metric.
postbackPartnerLogoUrl
string		Postback partner logo URL.
campaignCount
integer		Campaign count.
Response 200
{
  "success": true,
  "data": {
    "data": [
      {
        "id": 2539,
        "name": "conversion-197",
        "postbackPartnerName": null,
        "status": "Active",
        "type": "Pixel",
        "created": 1677805806,
        "totalConversion": 0,
        "owId": 201352,
        "createdByUowId": 6255,
        "modifiedByUowId": 6255,
        "uuid": "8f3165d0-b714-440e-bc1d-621127fa5fad",
        "pixelConversionScript": "<script src='https://pxl.stage.iqm.com/i/pixel/8f3165d0-b714-440e-bc1d-621127fa5fad?cv={CONVERSION_VALUE}' async></script>",
        "attributedConversion": 0,
        "attributedViewThroughConversion": 0,
        "attributedClickThroughConversion": 0,
        "pixelFinancialMetric": "test_metric",
        "postbackPartnerLogoUrl": "https://logo-bucket/partners/kochava.com",
        "campaignCount": 0
      }
    ],
    "totalRecords": 8,
    "filteredRecords": 1
  }
}

Get conversion count by type​

GET

Get a count of conversions based on type.

Query parameter
searchField
string		Filter results by search field.
Response properties
conversionType
string		Conversion type.
Supported values
1Pixel
2Postback
3Universal Pixel
conversionCount
integer		Conversion count.
order
integer		Order.
Response 200
{
  "success": true,
  "data": [
    {
      "conversionType": "PIXEL",
      "conversionCount": 1,
      "order": 1
    },
    {
      "conversionType": "POSTBACK",
      "conversionCount": 9,
      "order": 2
    }
  ]
}

Get campaign details by conversion ID​

GET

Get a list of campaign details by conversion ID.

Query parameter
conversionId
integer		Conversion ID.
Response properties
campaignId
integer		Campaign ID.
campaignName
string		Campaign name.
creativeTypeId
string		Creative type ID.
Supported values
0All
11Image
13HTML
14Video
15Native
17Audio
status
string		Campaign status.
startTime
integer		Unix epoch start time, in milliseconds.
endTime
integer		Unix epoch end time, in milliseconds.
ioId
integer		Insertion order ID.
ioName
string		Insertion order name.
ioStatusId
integer		Insertion order status ID.
Supported values
1Active
2Expired
3Deleted
ioBudgetTypeId
integer		Insertion order budget type ID.
Supported values
1Budget
2Impression
Response 200
{
  "success": true,
  "data": [
    {
      "campaignId": 1000,
      "campaignName": "Campaign 1",
      "creativeTypeId": 17, 
      "status": "expired",
      "startTime": 1888705936,
      "endTime": 1669420800,
      "ioId": 1,
      "ioName": "Insertion Order Name",
      "ioStatusId": 1,
      "ioBudgetTypeId": 1
    }
  ], 
  "totalRecords": 4,
  "filterRecords": 1
}

Get campaign details by conversion ID in group or basic​

POST

Get a list of allowed campaigns grouped by insertion order.

Request schema
conversionId
integer		Conversion ID.
owId
integer		Organization Workspace ID.
limit
integer		Number of entries returned per page, default: 20.
pageNo
integer		Page number of retrieved data, default: 1.
sortBy
string		Sorts by ascending (+) or descending (-), default: -ioId, -campaignId.
searchField
string		Filter results by search field.
Response properties
ioId
integer		Insertion order ID.
ioName
string		Insertion order name.
ioStatusId
integer		Insertion order status ID.
Supported values
1Active
2Expired
3Deleted
ioBudgetTypeId
integer		Insertion order budget type ID.
Supported values
1Budget
2Impression
created
integer		Unix epoch creation date, in milliseconds.
lastModified
integer		Unix epoch modified time, in milliseconds.
owID
integer		Organization Workspace ID.
uowID
integer		User Organization Workspace ID.
campaignCount
integer		Campaign count.
campaigns
object		Campaign details.
campaigns object properties
id
integer		Campaign ID.
campaignId
integer		Campaign ID.
name
string		Campaign name.
creativeTypeId
string		Creative type ID.
Supported values
0All
11Image
13HTML
14Video
15Native
17Audio
status
string		Campaign status.
startTime
integer		Unix epoch start time, in milliseconds.
endTime
integer		Unix epoch end time, in milliseconds.
createdAt
integer		Unix epoch creation date, in milliseconds.
modifiedAt
integer		Unix epoch modified time, in milliseconds.
owId
integer		Organization Workspace ID.
ioId
integer		Insertion order ID.
ioName
string		Insertion order name.
ioStatusId
integer		Insertion order status ID.
Supported values
1Active
2Expired
3Deleted
timezoneId
integer		Timezone ID.
campaignTypeId
integer		Campaign type ID.
Supported values
1Advanced campaign
2PG campaign
ioBudgetTypeId
integer		Insertion order budget type ID.
Supported values
1Budget
2Impression
targetedAudienceIds
array of integers		Targeted audience IDs.
prebidAudienceProviderId
integer		Pre-bid audience provider ID.
{
    "success": true,
    "data": {
        "totalRecords": 12,
        "ioCampaignsList": [
            {
                "ioId": 23405,
                "ioName": "dsjbegawhuje",
                "ioBudgetTypeId": 1,
                "ioStatusId": 1,
                "created": 1758022688258,
                "lastModified": 1760078918000,
                "owId": 201427,
                "uowId": 198031,
                "campaignCount": 1,
                "campaigns": [
                    {
                        "id": 568934,
                        "campaignId": 568934,
                        "name": "jou49034",
                        "creativeTypeId": 11,
                        "status": "pending",
                        "startTime": 1779204800,
                        "endTime": 2478830400,
                        "createdAt": 1759999354,
                        "modifiedAt": 1759968000000,
                        "owId": 201427,
                        "ioId": 0,
                        "ioName": null,
                        "ioStatusId": 0,
                        "timezoneId": 29,
                        "campaignTypeId": 1,
                        "ioBudgetTypeId": 0,
                        "targetedAudienceIds": null,
                        "prebidAudienceProviderId": null
                    }
                ]
            }
        ],
        "filteredRecords": 1
    }
}

Conversions management​

Create Pixel conversion​

POST

Create a Pixel type conversion.

Refer to the Pixel conversion resource properties table for request schema properties.

Minimum required properties:

  • name
  • attributionId
  • conversionSetting
    • conversionDuration
    • repeatConversion
Response properties
id
integer		Conversion ID.
name
string		Conversion name.
postbackPartnerName
string		Postback partner name.
status
string		Conversion status.
type
string		Conversion type.
created
integer		Unix epoch creation date, in milliseconds.
totalConversions
integer		Total conversions count.
owID
integer		Organization Workspace ID.
createdByUowId
integer		Created by User Organization Workspace ID.
modifiedByUowId
integer		Modified by User Organization Workspace ID.
uuid
integer		Universally unique identifier.
pixelConversionScript
string		Pixel conversion script.
attributedConversion
integer		The number of conversions that are attributed to a specific campaign based on the Attribution model.
attributedViewThroughConversion
integer		The number of conversions that occurred after a user viewed an ad but did not click on it
attributedClickThroughConversion
integer		The number of conversions that occurred after a user clicked on an ad
pixelFinancialMetric
string		Pixel financial metric.
postbackPartnerLogoUrl
string		Postback partner logo URL.
Request sample
{
    "name": "PixelConversion",
    "attributionId": "1",
    "customFields": [
        "field_1",
        "field_2",
        "field_3"
    ],
    "financialMetrics": "field_4",
    "piggybackData": {
        "url": "http://piggybackdata.com/url",
        "type": 1
    },
    "conversionSetting": {
        "conversionDuration": {
            "view": 10,
            "click": 10
        },
        "repeatConversion": {
            "count": 1,
            "frequency": 1,
            "unit": "Day"
        },
        "crossModelling": true
    }
}
Response 200
{
    "success": true,
    "data": {
        "id": 3213,
        "name": "PixelConversion",
        "postbackPartnerName": null,
        "status": "Pending",
        "type": "Pixel",
        "created": 1687459918,
        "totalConversions": 0,
        "owId": 202017,
        "createdByUowId": 108658,
        "modifiedByUowId": 108658,
        "uuid": "a574ca49cc244c3bb3089491a11aae43",
        "attributedConversions": 0,
        "attributedViewThroughConversions": 0,
        "attributedClickThroughConversions": 0,
        "pixelFinancialMetric": "name",
        "postbackPartnerLogoURL": null,
        "pixelConversionScript": "<script src='https://pxl.stage.iqm.com/i/pixel/8f3165d0-b714-440e-bc1d-621127fa5fad?cv={CONVERSION_VALUE}' async></script>",
        "partnerUrl": null
    }
}

Update Pixel conversion​

PATCH

Update the name and piggyback data of a Pixel type conversion.

Request schema
id
string		Postback conversion ID.
name
string		New Postback conversion name.
piggybackData
object		contains url and type properties.
url
string		Additional URL that can be added to a Pixel conversion to send conversion information to a third-party platform.
type
string		Piggyback type ID.
Supported values
1Image Pixel
2Javascript Pixel
Response properties
id
integer		Conversion ID.
name
string		Updated conversion name.
piggybackData
object		Piggyback data details.
piggybackdata object properties
url
string		Piggyback URL.
type
integer		Piggyback type ID.
Supported values
1Image Pixel
2Javascript Pixel
Request sample
{
  "id": "3114",
  "name": "Pixel Conversion Update testing",
  "piggybackData": {
    "url": "update piggybackData",
    "type": "1"
  }
}
Response 200
{
  "success": true,
  "data": {
    "id": 3114,
    "name": "Pixel Conversion Update testing",
    "piggybackData": {
      "url": "update piggybackData",
      "type": 1
    }
  }
}

Create Postback conversion​

POST

Create Postback type conversion records.

Request schema
name
string		Name for Postback conversion.
partnerTypeId
string		Partner type ID.
Supported values
1Kochava
2Singular
3Appsflyer
4Adjust
impressionsUrl
string		Impressions URL.
clickUrl
string		Click URL.
Response properties
id
integer		Conversion ID.
name
string		Conversion name.
partnerName
string		Postback partner name.
status
string		Conversion status.
type
string		Conversion type.
created
integer		Unix epoch creation date, in milliseconds.
totalConversions
integer		Total conversions count.
owID
integer		Organization Workspace ID.
createdByUowId
integer		Created by User Organization Workspace ID.
modifiedByUowId
integer		Modified by User Organization Workspace ID.
uuid
integer		Universally unique identifier.
attributedConversion
integer		The number of conversions that are attributed to a specific campaign based on the Attribution model.
attributedViewThroughConversion
integer		The number of conversions that occurred after a user viewed an ad but did not click on it
attributedClickThroughConversion
integer		The number of conversions that occurred after a user clicked on an ad
pixelFinancialMetric
string		Pixel financial metric.
postbackPartnerLogoUrl
string		Postback partner logo URL.
partnerUrl
string		Partner URL.
Request sample
{
    "name": "testing postback",
    "partnerTypeId": "1",
    "impressionUrl": "https://imp.control.kochava.com/track/impression?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603",
    "clickUrl": "https://control.kochava.com/v1/cpi/click?campaign_id?campaign_id=kodragons-blade-1svu3szpd4b2be3253705&network_id=3603"
}
Response 200
{
    "success": true,
    "data": {
        "id": 3215,
        "name": "testing postback",
        "partnerName": null,
        "status": "Active",
        "type": "Postback",
        "created": 1687460629,
        "totalConversions": 0,
        "owId": 202017,
        "createdByUowId": 108658,
        "modifiedByUowId": 108658,
        "uuid": "879127abaab7459585b602b1f25dec41",
        "attributedConversions": 0,
        "attributedViewThroughConversions": 0,
        "attributedClickThroughConversions": 0,
        "pixelFinancialMetric": null,
        "postbackPartnerLogoURL": "http://partnerUrl/partnerName",
        "partnerUrl": "http://partnerUrl/partnerName"
    }
}

Update Postback conversion​

PATCH

Update the name of a Postback type conversion.

Request schema
id
string		Postback conversion ID.
name
string		New Postback conversion name.
Response properties
id
integer		Conversion ID.
name
string		Updated conversion name.
Request sample
{
    "id": "3114",
    "name": "Postback Conversion Update testing"
}
Response 200
{
    "success": true,
    "data": {
        "id": 3114,
        "name": "Postback Conversion Update testing"
    }
}

Create a Universal Pixel conversion​

POST

Create a Universal Pixel type conversion. The status is set to Pending and a unique UUID is auto-generated on creation.

Request schema
name
string required		Display name for the conversion (3–255 characters).
attributionId
integer required		Attribution type ID.
Supported values
1Hybrid
2Click based
3View based
conversionSetting
object required		Advanced settings for the conversion.
conversionSetting object properties
conversionDuration
object required		Post-view and post-click attribution window durations.
conversionDuration object properties
view
integer		Post-view attribution window in days (1–30).
Overridden to system default when attributionId is Click-based.
click
integer		Post-click attribution window in days (7–60).
Overridden to system default when attributionId is View-based.
repeatConversion
object required		Controls how repeated conversions from the same user are counted.
repeatConversion object properties
count
integer required		Maximum number of repeat conversions to count per user.
frequency
integer required		Frequency interval for repeat conversion counting.
unit
string required		Time unit for the repeat frequency window (e.g. Day, Hour).
crossModelling
boolean		Whether cross-device modelling is enabled for attribution, default: false.
Response properties
id
integer		Conversion ID.
name
string		Conversion name.
status
string		Conversion status (always Pending on creation).
type
string		Conversion type (always Universal Pixel).
created_at
integer		Unix epoch timestamp of creation, in seconds.
totalConversions
integer		Total conversions count.
owId
integer		Organization Workspace ID.
createdByUowId
integer		Created by User Organization Workspace ID.
modifiedByUowId
integer		Modified by User Organization Workspace ID.
uuid
string		Universally unique identifier.
attributedConversions
integer		Number of conversions attributed to a campaign based on the attribution model.
attributedViewThroughConversions
integer		Number of conversions that occurred after a user viewed an ad but did not click
attributedClickThroughConversions
integer		Number of conversions that occurred after a user clicked an ad
campaignCount
integer		Number of campaigns this conversion is assigned to.
pixelConversionScript
string		JavaScript snippet to embed on your webpage for this Universal Pixel conversion.
Request sample
{
  "name": "UniversalPixelConversion",
  "attributionId": 1,
  "conversionSetting": {
    "conversionDuration": {
      "view": 10,
      "click": 10
    },
    "repeatConversion": {
      "count": 1,
      "frequency": 1,
      "unit": "Day"
    },
    "crossModelling": true
  }
}
Response 200
{
  "success": true,
  "data": {
    "id": 3300,
    "name": "UniversalPixelConversion",
    "status": "Pending",
    "type": "Universal Pixel",
    "created_at": 1687459918,
    "totalConversions": 0,
    "owId": 202017,
    "createdByUowId": 108658,
    "modifiedByUowId": 108658,
    "uuid": "d3f2a1b0-c514-44ee-ab2d-7321fa6dbc90",
    "attributedConversions": 0,
    "attributedViewThroughConversions": 0,
    "attributedClickThroughConversions": 0,
    "campaignCount": 0,
    "pixelConversionScript": "<script src='https://pxl.stage.iqm.com/i/pixel/d3f2a1b0?cv={CONVERSION_VALUE}' async></script>"
  }
}

Update a Universal Pixel conversion​

PATCH

Update the name of an existing Universal Pixel conversion.

Request schema
id
integer required		Conversion ID of the Universal Pixel conversion to update.
name
string required		New display name (3–255 characters).
Response properties
id
integer		Conversion ID.
name
string		Updated conversion name.
Request sample
{
  "id": 3300,
  "name": "My Renamed Universal Pixel Conversion"
}
Response 200
{
  "success": true,
  "data": {
    "id": 3300,
    "name": "My Renamed Universal Pixel Conversion"
  }
}

Delete conversion​

DELETE

Delete one or multiple conversions.

Query parameters
conversionIds
string		Comma separated conversion IDs to delete.
Response properties
success
boolean		Indicates conversion was successfully deleted: true.
data
string		Success message.
Response 200
{
    "success": true,
    "data": "Conversion has been deleted successfully!"
}

Assign conversion to a campaign​

POST

Assign a conversion to a campaign while validating conversion IDs and campaign IDs.

info

Conversions can be assigned, updated, or removed from a campaign only before the campaign is running.

Query parameters
assignConversionToCampaign
string		Map containing details list of campaign IDs which need to be added/removed.
Request schema
conversionIdList
array of integers		Conversion IDs to assign.
addCampaignsList
array of integers		Campaign IDs to assign conversions to.
removeCampaignsList
array of integers		Campaign IDs to remove assigned conversions from.
Response properties
conversionIdsList
integer		Conversion IDs assigned to campaigns.
validAddCampaignIdsList
array of integers		Validated campaign IDs to assign a conversion to.
invalidAddCampaignIdsList
array of integers		Invalid campaign IDs to assign a conversion to.
validRemoveCampaignIdsList
array of integers		Validated campaign IDs to remove a conversion from.
invalidRemoveCampaignIdsList
array of integers		Invalid campaign IDs to remove a conversion from.
Request sample
{
  "conversionIdList": [
    3925
  ],
  "addCampaignsList": [
    25396,
    256374,
    234567
  ],
  "removeCampaignsList": [
    256321,
    256432,
    256433
  ]
}
Response 200
{
  "success": true,
  "data": {
    "conversionIdsList": 3925,
    "validAddCampaignIdsList": [
      253396,
      256374
    ],
    "invalidAddCampaignIdsList": [
      234567
    ],
    "validRemoveCampaignIdsList": [
      256321,
      256432
    ],
    "invalidRemoveCampaignIdsList": [
      256433
    ]
  }
}

Send email for Pixel integration​

POST

Send an email containing information of integration pixel in html.

Request schema
conversionId
string		Conversion ID.
recipients
string		Comma separated emails to send pixel integration to.
emailSubject
string		Subject of email.
emailText
string		Text of email.
Response properties
success
boolean		Indicates email was succesfully sent: true.
data
string		Success message.
Request sample
{
  "conversionId": "3114",
  "recipients": "username@gmail.com,anotherUser@yahoo.com",
  "emailSubject": "Integrate Pixel Conversion",
  "emailText": "Hello IQM has sent you a pixel code to integrate. Please follow the steps below to integrate the pixel code."
}
Response 200
{
  "success": true,
  "data": "Pixel Conversion e-mail sent successfully."
}

Send email for Universal Pixel integration​

POST

Send an email containing the Universal Pixel script tag and integration instructions to one or more recipients.

Request schema
conversionId
integer required		Conversion ID of the Universal Pixel conversion to share.
recipients
string required		Comma-separated list of recipient email addresses.
emailSubject
string required		Subject line for the outgoing email.
emailText
string		Opening greeting text rendered in the email body, supports the ${userName} token.
Response properties
data
string		Success message confirming the email was dispatched.
Request sample
{
  "conversionId": 3300,
  "recipients": "developer@example.com,partner@example.com",
  "emailSubject": "Integrate Universal Pixel Conversion",
  "emailText": "Hello ${userName} has sent you a Universal Pixel code to integrate. Please follow the steps below."
}
Response 200
{
  "success": true,
  "data": "Universal Pixel conversion e-mail sent successfully."
}

More conversion details​

This section covers the methods and endpoints for getting more details and static lists about conversions.

Get list of partner types for Postback conversions​

GET

Get list of partner details for Postback conversions like logo and name.

Query parameters
searchField
string		Filter results by search field.
partnerTypeIds
string		Filters by partner type IDs.
Partner Type IDs
1Kochava.
2Singular.
3Appsflyer.
4Adjust.
Response 200
{
  "success": true,
  "data": {
    "data": [
      {
        "id": 1,
        "name": "Kochava",
        "logoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/static/partners/kochava.com",
        "order": 1,
        "active": true
      },
      {
        "id": 2,
        "name": "Singular",
        "logoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/static/partners/singular.net",
        "order": 2,
        "active": true
      },
      {
        "id": 3,
        "name": "Appsflyer",
        "logoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/static/partners/appsflyer.com",
        "order": 3,
        "active": true
      },
      {
        "id": 4,
        "name": "Adjust",
        "logoUrl": "https://d2v0lj9tfbnmhu.cloudfront.net/assets/static/partners/adjust.com",
        "order": 4,
        "active": true
      }
    ],
    "totalRecords": 4,
    "filteredRecords": 4
  }
}

Get list of Pixel conversion advanced setting default values​

GET

Get a list and details about default values of advanced settings for Pixel-based conversions.

Default Values IDs
1Post Click Interval.
2Post View Interval.
3Cross Device.
Response 200
{
  "success": true,
  "data": {
    "data": [
    {
      "id": 1,
      "name": "post_click_interval",
      "displayName": "Post Click Interval",
      "value": "15",
      "active": true
    },
    {
      "id": 2,
      "name": "post_view_interval",
      "displayName": "Post View Interval",
      "value": "28",
      "active": true
    },
    {
      "id": 3,
      "name": "cross_device",
      "displayName": "Cross Device",
      "value": "true",
      "active": true
    }
    ],
    "totalRecords": 3,
    "filteredRecords": 3
  }
}

Get list of conversion types​

GET

Get a list and details of conversion types.

Query parameters
searchField
string		Filter results by search field.
conversionTypeIds
string		Filters by conversion type IDs.
Supported values
1Pixel
2Postback
3Universal Pixel
Conversion Type IDs
1Pixel.
2Postback.
3Universal Pixel.
Response 200
{
    "success": true,
    "data": {
        "data": [
            {
                "id": 1,
                "name": "pixel",
                "displayName": "Pixel",
                "order": 1,
                "isActive": true
            },
            {
                "id": 2,
                "name": "postback",
                "displayName": "Postback",
                "order": 2,
                "isActive": true
            },
            {
                "id": 3,
                "name": "universalPixel",
                "displayName": "Universal Pixel",
                "order": 3,
                "isActive": true
            }
        ],
        "totalRecords": 3,
        "filteredRecords": 3
    }
}

Get list of conversion status​

GET

Get a list of conversion status.

Query parameters
searchField
string		Filter results by search field.
statusIds
string		Filters by status type IDs.
Conversion Status IDs
1Active.
2Pending.
Response 200
{
  "success": true,
  "data": {
    "data": [
      {
        "id": 1,
        "name": "active",
        "displayName": "Active",
        "order": 1,
        "active": true
      },
      {
        "id": 2,
        "name": "pending",
        "displayName": "Pending",
        "order": 2,
        "active": true
      }
    ],
    "totalRecords": 2,
    "filteredRecords": 2
  }
}

Get list of conversion piggyback types​

GET

Get a list of conversion piggyback types.

Query parameters
searchField
string		Filter results by search field.
piggybackTypeIds
string		Filters by piggyback type IDs.
Piggyback Type IDs
1Image Pixel.
2Javascript Pixel.
Response 200
{
  "success": true,
  "data": {
    "data": [
      {
        "id": 1,
        "name": "image_pixel",
        "displayName": "Image Pixel",
        "order": 1,
        "active": true
      },
      {
        "id": 2,
        "name": "javascript_pixel",
        "displayName": "Javascript Pixel",
        "order": 2,
        "active": true
      }
    ],
    "totalRecords": 2,
    "filteredRecords": 2
  }
}

Get list of conversion property types​

GET

Get a list of conversion property types.

Query parameters
searchField
string		Filter results by search field.
attributionTypeIds
string		Filters by attribution type IDs.
Conversion Property Type IDs
1
Hybrid		Hybrid attribution combines both click-based and view-based methods to assign credit for a conversion either to an ad that was last clicked or to an ad that was last viewed.
3
View Based		View-based attribution gives credit to an ad that a user saw, but did not necessarily interact with, before making a conversion.
2
Click Based		Click-based attribution assigns credit for a conversion to the last ad that a user clicked on before making a purchase or taking an action.
Response 200
{
  "success": true,
  "data": {
    "data": [
      {
        "id": 1,
        "name": "hybrid",
        "displayName": "Hybrid",
        "order": 1,
        "description": "Hybrid attribution combines both click-based and view-based methods to assign credit for a Conversion either to an ad that was last clicked or to an ad that was last viewed.",
        "active": true
      },
      {
        "id": 3,
        "name": "view_based",
        "displayName": "View Based",
        "order": 2,
        "description": "View-based attribution gives credit to an ad that a user saw, but did not necessarily interact with, before making a Conversion.",
        "active": true
      },
      {
        "id": 2,
        "name": "click_based",
        "displayName": "Click Based",
        "order": 3,
        "description": "Click-based attribution assigns credit for a Conversion to the last ad that a user clicked on before making a purchase or taking an action.",
        "active": true
      }
    ],
    "totalRecords": 3,
    "filteredRecords": 3
  }
}
Have a question?
Ask the community
Was this page helpful?