Conversions API

Overview

The Conversions API allows you to get details, lists, and create Conversions to track user traffic for advertising campaigns. This page covers the common endpoints and methods associated with the Conversions API.

The IQM platform supports two types of Conversions:

Pixel Conversions are client-side tracking and they feature advanced settings for fine-tuned optimization.
Postback Conversions are server-side.

Learn more about Conversions with our Help Center articles.

Authentication

Use the following header parameters for all requests:

Headers
`Authentication` string required	Authentication bearer token See Authentication Guide
`X-IAA-OW-ID` integer required	Organization Worskpace ID Header

Get Conversion Details

Postback Conversion Resource Properties

Resource Properties

`id` integer	Postback Conversion ID
`name` string	Postback Conversion name
`uuid` string	Universal user ID
`typeId` integer	Conversion Type ID
`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
`partnerTypeId` integer	Partner Type ID
`impressionUrl` string	Impression URL
`clickUrl` string	Click URL

Pixel Conversion Resource Properties

Property Table

id
integer Pixel Conversion ID

uuid
string Universal user ID

typeId
integer Conversion Type ID

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

created
integer Unix epoch timestamp of Pixel Conversion creation, in milliseconds

name
string Name for Pixel Conversion

attributionId
string Attribution Type ID

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 Contains url and type properties

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

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 /api/v3/conversion/{conversionId}

Get details about a Conversion from its ID.

Path Parameter
`conversionId` integer	Conversion ID
`typeId` integer	Conversion Type ID for which the details will be returned Pixel: `1` Postback: `2`

JSON
TypeScript

Response 200
{
  "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
    }
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
          uuid: string;
          typeId: number;
          owId: number;
          createdByUowId: number;
          modifiedByUowId: number;
          attributionId: number;
          statusId: number;
          customFields: string[];
          financialMetrics: string;
          piggybackData: {
            url: string;
            type: number
          }
          pixelConversionScript: string;
          conversionSetting: {
            conversionDuration: {
              view: number;
              click: number;
            }
            repeatConversion: {
              count: number;
              frequency: number;
              unity: string;
            }
            crossModelling: boolean
          }
        }
      }
    };
  };
};

function getConversionDetailsById(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/{conversionId}',
    parameters: {
      query?: {
        typeId?: `number`,
      },
      path: {
        conversionId: `number`
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get List of Conversions

GET /api/v3/conversion/list

Get a list of Conversions with details and filters.

Query Parameters
`searchField` string	Search results by keyword
`limit` integer	Maximum number of entries returned, default: `20`
`pageNo` integer	Page number for the data, default: `1`
`sortBy` string	Sorts by ascending (`+`) or descending (`-`), default: `-created`
`conversionsId` string	Conversion ID
`typeIds` string	Filters by Conversion Type ID Pixel: `1` Postback: `2`
`statusIds` string	Filters by Conversion Status ID Active:`1` Pending: `2`
`postbackPartnerIds` string	Filters by postback Conversion type IDs

JSON
TypeScript

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
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            postbackPartnerName: string;
            status: string;
            type: string;
            created: number;
            totalConversion: number;
            owId: number;
            createdByUowId: number;
            modifiedByUowId: number;
            uuid: string;
            pixelConversionScript: string;
            attributedConversion: number;
            attributedViewThroughConversion: number;
            attributedClickThroughConversion: number;
            pixelFinancialMetric: string;
            postbackPartnerLogoUrl: string;
            campaignCount: number
          }[];
          totalRecords: number;
          filteredRecords: number
        }
      }
    };
  };
};

function getConversionList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/list',
    parameters: {
      query?: {
        searchField?: `string`,
        limit?: `number`,
        pageNo?: `number`,
        sortBy?: `string`,
        conversionIds?: `string`,
        typeIds?: `string`,
        statusIds?: `string`,
        postbackPartnerIds?: `string`,
      },
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get Conversion Count by Type

GET /api/v3/conversion/type-wise-count

Get a count of Conversions based on type.

Query Parameter
`searchField` string	Search results by keyword

JSON
TypeScript

Response 200
{
  "success": true,
  "data": [
    {
      "conversionType": "PIXEL",
      "conversionCount": 1,
      "order": 1
    },
    {
      "conversionType": "POSTBACK",
      "conversionCount": 9,
      "order": 2
    }
  ]
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          conversionType: string;
          conversionCount: number;
          order: number
        }[]
      }
    };
  };
};

function getConversionCountTypeWise(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/type-wise-count',
    parameters: {
      query?: {
        searchField?: `string`,
      },
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get Campaign Details by Conversion ID

GET /api/v3/conversion/attached/campaigns/list

Get a list of Campaign details by Conversion ID.

Query Parameter
`conversionId` integer	Conversion ID

JSON
TypeScript

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
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          campaingId: number;
          campaignName: string;
          creativeTypeId: number;
          status: string;
          startTime: number;
          endTime: number;
          ioId: number;
          ioName: string;
          ioStatusID: number;
          ioBudgetTypeId: number;
        }[];
        totalRecords: number;
        filteredRecords: number;
      }
    };
  };
};

function getAttachedCampaignsListByConversionId(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/attached/campaigns/list',
    parameters: {
      query?: {
        conversionId?: `string`,
      },
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get Campaign Details by Conversion ID in Group or Basic

GET /api/v3/conversion/allowed/campaign-list

Get a list of Campaign details by Conversion ID in group details or basic details.

Query Parameters
`conversionId` integer	Conversion ID
`owId` integer	Organization Workspace ID
`isGroup` boolean	Flag for fetching group details (`true`) or basic details (`false`)
`limit` integer	Maximum number of entries returned, default: `20`
`pageNo` integer	Page number for the data, default: `1`
`sortBy` string	Sorts by ascending (`+`) or descending (`-`), default: `-ioId`, `-campaignId`
`searchField` string	Search results by keyword

JSON
TypeScript

{
  "success": true,
  "data": [
    {
      "ioId": 1215,
      "ioName": "new name",
      "ioBudgetTypeId": 1,
      "ioStatusId": 0,
      "created": 1693886215726,
      "lastModified": 1695216128000,
      "owId": 201427,
      "uowId": 111357,
      "campaignCount": 1,
      "campaigns": [
        {
          "id": 437060,
          "campaignId": 437060,
          "name": "Test-CB-2229",
          "creativeTypeId": 11,
          "status": "running",
          "startTime": 1793972800,
          "endTime": 0,
          "createdAt": 1694153838,
          "modifiedAt": 1695945600000,
          "owId": 201427,
          "ioId": 0,
          "ioName": null
        }
      ]
    }
  ]
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          ioId: number;
          ioName: string;
          ioBudgetTypeId: number;
          ioStatusId: number;
          created: number;
          lastModified: number;
          owId: number;
          uowId: number;
          campaignCount: number;
          campaigns: {
            id: number;
            campaignId: number;
            name: string;
            creativeTypeId: number;
            status: string;
            startTime: number;
            endTime: number;
            createdAt: number;
            modifiedAt: number;
            owId: number;
            ioId: number;
            ioName: string;
          }[]
        }[]
      }
    };
  };
};

function getAttachableCampaignListByConversionIds(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/allowed/campaign-list',
    parameters: {
      query?: {
        conversionIds?: `string`,
        owId?: `string`,
        isGroup?: `string`,
        limit?: `number`,
        pageNo?: `number`,
        sortBy?: `string`,
        searchField?: `string`,
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Conversions Management

Create Postback Conversion

POST /api/v3/conversion/postback/add

Create postback type Conversion records.

Request Schema
`name` string	Name for postback Conversion
`partnerTypeId` string	Partner type ID
`impressionsUrl` string	Impressions URL
`clickUrl` string	Click URL

JSON
TypeScript

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"
    }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
          partnerName: string;
          status: string;
          type: string;
          created: number;
          totalConversions: number;
          owId: number;
          createdByUowId: number;
          modifiedByUowId: number;
          uuid: string;
          attributedConversions: number;
          attributedViewThroughConversion: number;
          attributedClickThroughConversions: number;
          pixelFinancialMetric: null;
          postbackPartnerLogoURL: string;
          partnerUrl: string;
        }
      }
    };
  };
};

function addPostbackConversion(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://app.iqm.com/api/v3/conversion/postback/add',
    requestBody: {
      content: {
        "application/json": {
          id?: `number`,
          name: `string`,
          uuid?: `string`,
          typeId?: `number`,
          owId?: `number`,
          createdByUowId?: `number`,
          modifiedByUowId?: `number`,
          statusId?: `number`,
          status?: `string`,
          created?: `number`,
          partnerTypeId?: `number`,
          impressionUrl: `string`,
          clickUrl: `string`,
        }
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Create Pixel Conversion

POST /api/v3/conversion/pixel/add

Create a pixel type Conversion.

Refer to the Pixel Conversion Resource Properties table for request schema properties.

JSON
TypeScript

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
    }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
          postbackPartnerName: string;
          status: string;
          type: string;
          created: number;
          totalConversions: number;
          owId: number;
          createdByUowId: number;
          modifiedByUowId: number;
          uuid: string;
          attributedConversions: number;
          attributedViewThroughConversions: number;
          attributedClickThroughConversions: number;
          pixelFinancialMetric: null;
          postbackPartnerLogoURL: string;
          pixelConversionScript: string;
          partnerUrl: string;
        }
      };
    };
  };
};

function addPixelConversion(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://app.iqm.com/api/v3/conversion/pixel/add',
    requestBody: {
      content: {
        "application/json": {
          id?: `number`,
          name: `string`,
          uuid?: `string`,
          typeId?: `number`,
          owId?: `number`,
          createdByUowId?: `number`,
          modifiedByUowId?: `number`,
          statusId?: `number`,
          status?: `string`,
          created?: `number`,
          attributionId?: `number`,
          customFields?: `array of strings`,
          financialMetrics?: `string`,
          piggybackData?: {
            url?: `string`,
            type?: `number`,
          },
          pixelConversionScript?: `string`,
          conversionSetting: {
            conversionDuration: {
              view?: `number`,
              click?: `number`,
            },
            repeatConversion: {
              count: `number`,
              frequency: `number`,
              unit: `string`,
            },
            crossModelling?: `boolean`,
          }
        }
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Delete Conversion

DELETE /api/v3/conversion/delete

This API provides a soft delete functionality for Conversions.

Query Parameters
`conversionIds` string	Comma separated Conversion IDs to delete

JSON
TypeScript

Response 200
{
    "success": true,
    "data": "Conversion has been deleted successfully!"
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string;
      }
    };
  };
};

function deleteConversions(): Promise<Responses> {
  const options = {
    method: 'DELETE',
    url: 'https://app.iqm.com/api/v3/conversion/delete',
    params: {
      query: {
        conversionIds: `string`
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Update Postback Conversion

PATCH /api/v3/conversion/postback/update

Update the name of a postback type Conversion.

Request Schema
`id` string	Postback Conversion ID
`name` string	New postback Conversion name

JSON
TypeScript

Request Sample
{
    "id": "3114",
    "name": "Postback Conversion Update testing"
}

Response 200
{
    "success": true,
    "data": {
        "id": 3114,
        "name": "Postback Conversion Update testing"
    }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
        }
      }
    };
  };
};

function updateConversion(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://app.iqm.com/api/v3/conversion/postback/update',
    requestBody: {
      content: {
        "application/json": {
          id?: `number`,
          name: `string`,
        }
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Update Pixel Conversion

PATCH /api/v3/conversion/pixel/update

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

JSON
TypeScript

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
    }
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          name: string;
          piggybackData: {
            url: string;
            type: number
          }
        }
      }
    };
  };
};

function updateConversion_1(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://app.iqm.com/api/v3/conversion/pixel/update',
    requestBody: {
      content: {
        "application/json": {
          id?: `number`,
          name: `string`,
          piggybackData?: {
            url?: `string`,
            type?: `number`,
          }
        }
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Assign Conversion to a Campaign

PATCH /api/v3/conversion/assign-to/campaign

Assign a Conversion to a Campaign while validating Conversion IDs and Campaign IDs.

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

JSON
TypeScript

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
    ]
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          conversionIdsList: number;
          validAddCampaignIdsList: number[];
          validRemoveCampaignIdsList: number[];
          invalidRemoveCampaignIdsList: number[]
        }
      }
    };
  };
};

function assignConversionToCampaign(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://app.iqm.com/api/v3/conversion/assign-to/campaign',
    params: {
      query: {
        assignConversionToCampaign?: `string`
      }
    },
    requestBody: {
      content: {
        "application/json": {
          conversionIdList?: `array of numbers`,
          addCampaignsList?: `array of numbers`,
          removeCampaignsList?: `array of numbers`,
        }
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Send Email for Pixel Integration

POST /api/v3/conversion/pixel/send-email

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

JSON
TypeScript

Request Sample
{
  "conversionId": "3114",
  "recipients": "username@gmail.com,anotherUser@yahoo.com",
  "emailSubject": "Integrate Pixel Conversion",
  "emailText": "Hello ${userName} 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."
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string
      }
    };
  };
};

function sendEmailForPixelConversion(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://app.iqm.com/api/v3/conversion/pixel/send-email',
    requestBody: {
      content: {
        "application/json": {
          advertiserId?: `number`,
          dspId?: `number`,
          owId?: `number`,
          uowId?: `number`,
          conversionId?: `number`,
          recipients: `string`,
          recipientsList?: `array of strings`,
          emailSubject: `string`,
          emailText?: `string`,
        }
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

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 /api/v3/conversion/static/postback/partner-type

Get list of partner details for postback Conversions like logo and name.

Query Parameters
`searchField` string	Search results by keyword
`partnerTypeIds` string	Filters by partner type IDs

Partner Type IDs
`1`	Kochava
`2`	Singular
`3`	Appsflyer
`4`	Adjust

JSON
TypeScript

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
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            logoUrl: string;
            order: number;
            active: string;
          }[];
          filteredRecords: number;
          totalRecords: number
        }
      }
    };
  };
};

function getListOfConversionPartnerType(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/static/postback/partner-type',
    params: {
      query: {
        searchField?: `string`,
        partnerTypeIds?: `string`
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get List of Pixel Conversion Advanced Setting Default Values

GET /api/v3/conversion/static/pixel/conversion-default-advanced-setting-data

Get a list and details about default values of advanced settings for pixel based Conversions.

Default Values IDs
`1`	Post Click Interval
`2`	Post View Interval
`3`	Cross Device

JSON
TypeScript

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
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            displayName: string;
            value: number;
            active: boolean;
          }[];
          totalRecords: number;
          filteredRecords: number
        }
      }
    };
  };
  403: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": unknown;
    };
  };
  500: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": unknown;
    };
  };
};

function getConversionDefaultAdvancedSettingData(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/static/pixel/conversion-default-advanced-setting-data',
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get List of Conversion Types

GET /api/v3/conversion/static/conversion-type

Get a list and details of Conversion types.

Query Parameters
`searchField` string	Search results by keyword
`conversionTypeIds` string	Filters by Conversion type IDs

Conversion Type IDs
`1`	Pixel
`2`	Postback

JSON
TypeScript

Response 200
{
  "success": true,
  "data": {
    "data": [
        {
          "id": 1,
          "name": "pixel",
          "displayName": "Pixel",
          "order": 1,
          "active": true
        },
        {
          "id": 2,
          "name": "postback",
          "displayName": "Postback",
          "order": 2,
          "active": true
        }
    ],
    "totalRecords": 2,
    "filteredRecords": 2
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            displayName: string;
            order: number;
            active: boolean
          }
        }
      }
    };
  };
};

function getListOfConversionTypes(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/static/conversion-type',
    params: {
      query?: {
        searchField?: `string`,
        conversionTypeIds?: `string`,
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get List of Conversion Status

GET /api/v3/conversion/static/conversion-status

Get a list of Conversion status.

Query Parameters
`searchField` string	Search results by keyword
`statusIds` string	Filters by status type IDs

Conversion Status IDs
`1`	Active
`2`	Pending

JSON
TypeScript

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
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            displayName: string;
            order: number;
            active: boolean;
          }[];
          totalRecords: number;
          filteredRecords: number
        }
      }
    };
  };
};

function getListOfConversionStatus(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/static/conversion-status',
    params: {
      query?: {
        searchField?: `string`,
        statusIds?: `string`,
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get List of Conversion Piggyback Types

GET /api/v3/conversion/static/conversion-piggyback-type

Get a list of Conversion piggyback types.

Query Parameters
`searchField` string	Search results by keyword
`piggybackTypeIds` string	Filters by piggyback type IDs

Piggyback Type IDs
`1`	Image Pixel
`2`	Javascript Pixel

JSON
TypeScript

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
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            displayName: string;
            order: number;
            active: boolean;
          }[];
          totalRecords: number;
          filteredRecords: number
        }
      }
    };
  };
};

function getListOfConversionPiggybackTypes(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/static/conversion-piggyback-type',
    params: {
      query?: {
        searchField?: `string`,
        piggybackTypeIds?: `string`,
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Get List of Conversion Property Types

GET /api/v3/conversion/static/conversion-attribution-type

Get a list of Conversion property types.

Query Parameters
`searchField` string	Search results by keyword
`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
`2` View Based	View-based attribution gives credit to an ad that a user saw, but did not necessarily interact with, before making a Conversion
`3` 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

JSON
TypeScript

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
  }
}

See TypeScript Prerequisites page for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            name: string;
            displayName: string;
            order: number;
            description: string;
            active: boolean
          }[];
          totalRecords: number;
          filteredRecords: number
        }
      }
    };
  };
};

function getListOfConversionAttributionTypes(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://app.iqm.com/api/v3/conversion/static/conversion-piggyback-type',
    params: {
      query?: {
        searchField?: `string`,
        attributionTypeIds?: `string`,
      }
    }
  };
  
  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Overview​

Authentication​

Get Conversion Details​

Postback Conversion Resource Properties​

Pixel Conversion Resource Properties​

Get Conversion Details by ID​

Get List of Conversions​

Get Conversion Count by Type​

Get Campaign Details by Conversion ID​

Get Campaign Details by Conversion ID in Group or Basic​

Conversions Management​

Create Postback Conversion​

Create Pixel Conversion​

Delete Conversion​

Update Postback Conversion​

Update Pixel Conversion​

Assign Conversion to a Campaign​

Send Email for Pixel Integration​

More Conversion Details​

Get List of Partner Types for Postback Conversions​

Get List of Pixel Conversion Advanced Setting Default Values​

Get List of Conversion Types​

Get List of Conversion Status​

Get List of Conversion Piggyback Types​

Get List of Conversion Property Types​

Overview

Authentication

Get Conversion Details

Postback Conversion Resource Properties

Pixel Conversion Resource Properties

Get Conversion Details by ID

Get List of Conversions

Get Conversion Count by Type

Get Campaign Details by Conversion ID

Get Campaign Details by Conversion ID in Group or Basic

Conversions Management

Create Postback Conversion

Create Pixel Conversion

Delete Conversion

Update Postback Conversion

Update Pixel Conversion

Assign Conversion to a Campaign

Send Email for Pixel Integration

More Conversion Details

Get List of Partner Types for Postback Conversions

Get List of Pixel Conversion Advanced Setting Default Values

Get List of Conversion Types

Get List of Conversion Status

Get List of Conversion Piggyback Types

Get List of Conversion Property Types