The conversion path object

The conversion path object holds information about each conversion path, as well as the tracked event(s) within each conversion path. You can retrieve a conversion path's object as well as list all conversion path objects.

Attributes

CampaignId integer

Id of the program (formerly known as campaign) that contains the conversion path.

CampaignName string

Name of the program (formerly known as campaign) that contains the conversion path.

Uri string

The conversion path’s direct URI.

Summary attributes

View summary attributes

ModelId integer

Id of the attribution model that is responsible for creating the conversion path.

ModelName string

Name of the attribution model that is responsible for creating the conversion path.

MediaCount integer

How many partners (formerly known as media partners) and media sources were involved in the conversion path.

ChannelCount integer

How many channels were involved in the conversion path.

Latency decimal

Time difference between the first activity (e.g., Impression) in a path and the final sale.

Steps integer

How many activities (e.g., Impressions) occurred in the conversion path.

Revenue decimal

Revenue driven by the final event (typically a sale) in the conversion path.

Cost decimal

Total cost of driving the conversion path.

CustomerId string

Id of the customer that created the conversion path.

Event-level attributes

View event-level attributes

Events array

An array of objects containing details of each event within a conversion path.

View child attributes

Id string

Id of an event within the conversion path.

Type enum

Type of an event within the conversion path.

View possible enum values
ConversionThe event reflected in this array was a conversion.
ReferralThe event reflected in this array was a referral.

SubType enum

More specific information about an event within the conversion path.

View possible enum values
ImpressionThe conversion path model tracked an impression. This can appear for Referral events.
ClickThe conversion path model tracked a click. This can appear for Referral events.
SALEThe conversion path model tracked a sale event. This can appear for Conversion events.
MOBILE_APPThe conversion path model tracked a mobile app install. This call appear for Conversion events.
PARTNER_REFERRALThe conversion path model tracked a partner referral. This call appear for Conversion events.
LEADThe conversion path model tracked a lead generation. This call appear for Conversion events.

EventDate datetime

Date and time of the event occurrence. See ISO-8601.

Step string

Which step in the conversion path the event represents. Will be empty if Steps: "1". Uses 1-base indexing (i.e., first step will appear with 1, next step is 2, last step will be n).

PositionType enum

How the step affected with the conversion path as a whole. Is empty if "Type": Conversion.

View possible enum values
IntroducerThis referral step began the conversion path
InfluencerThis referral step interacted with the conversion path, but did not begin or end it.
CloserThis referral step directly led to the conversion event in the conversion path.

LandingPage string

Landing page's URL for the event object this attribute is contained in.

MediaId integer

Id of the partner (formerly known as media partner) or media source that drove the step.

MediaName string

Name of the partner (formerly known as media partner) or media source that drove the step.

Channel string

Which channel drove the event this attribute is contained in.

AdDistributionType string

Which third-party ad distributor served the ad (e.g., Google Ads).

AdCampaign string

Name of the third-party grouping that this step in the conversion path is grouped with.

AdGroup string

Which third-party ad group that this step in the conversion path is contained in (e.g., Paid Search).

AdId integer

Id of the ad that generated this step in the conversion path.

AdName string

Name of the ad that generated this step in the conversion path.

AdType string

Type of the ad that generated this step in the conversion path.

View possible enum values
BANNERClick was generated on a banner ad.
EMAILClick was generated on an email ad.
FLASHClick was generated on a flash player ad.
TEXTClick was generated on a sponsored text ad.
TEXT_LINKClick was generated on a text hyperlink ad.
LONG_SPONSORED_TEXTClick was generated on a long sponsored text ad.
XML_SYNDICATIONClick was generated on an XML syndication.
COUPONClick was generated on a coupon ad.
CONTENTPartner requested an additional content ad tracking value.
VIDEOClick was generated on a video ad.
ONLINE_TRACKING_LINKClick was generated on an online tracking link ad.
MEDIA_SOURCE_TRACKINGClick was generated on a media source (e.g., an SEO source).

Keyword string

Word used in Paid Search efforts.

MatchType string

How Paid Search marketing efforts will match your Keyword to user searches.

TrafficType string

Where users come from when a partner directs them to your site.

AdSiteLocation string

Where on the referral site the ad is hosted.

ReferringUrl string

Url of the website that referred the customer.

AttributedCredit decimal

What percentage the attribution model credits a specific partner for their efforts in driving the final event. Will be between 0 and 1.

AttributedRevenue string

The total Revenue multiplied by the AttributedCredit. This is the amount a partner earns for their efforts in driving the final event.

ActionId string

Id of the action.

ActionDate datetime

Date and time of the action occurrence. See ISO-8601.

ActionTrackerId integer

Id of the associated event type (formerly known as action tracker).

ActionTrackerName string

Name of the associated event type (formerly known as action tracker).

Amount decimal

Amount of money spent by the customer.

Payout decimal

Total payout for the conversion.

More Events attributes

View more child attributes

SiteVersion string

Landing site's version identifier.

SiteCategory string

What category the landing site is listed in.

CustomerStatus string

Customer status mapping code.

CustomerPostCode string

What postal code the customer performed the conversion path step from.

CustomerArea string

What geographical area the customer performed the conversion path step from.

CustomerCity string

What city the customer performed the conversion path step from.

CustomerRegion string

What geographical region the customer performed the conversion path step from.

CustomerCountry string

What country the customer performed the conversion path step from.

DeviceType enum

What type of device the customer used to perform the step.

View possible enum values
DESKTOPConsumer generated the click from a personal computer.
PHONEConsumer generated the click using a mobile phone.
TABLETConsumer generated the click using a tablet computer.
GAMEConsumer generated the click from a mobile game.
WATCHConsumer generated the click from a smart watch.
TVConsumer generated the click from a TV ad.
ROBOTA robot generated the click.
CARConsumer generated the click from a their car.
UNKNOWNThe DeviceType could not be tracked.

DeviceFamily enum

General group of devices that the attribute DeviceType comes from. Only a sample of all enum values are presented below.

View possible enum values
WINDOWS_MACHINEConsumer generated the click using a Windows machine.
LINUX_MACHINEConsumer generated the click using a Linux machine.
APPLE_MACConsumer generated the click using an Apple machine.
IPHONEConsumer generated the click using an iPhone.
IPADConsumer generated the click using an iPad.
ONEConsumer generated the click using a OnePlus One mobile device.
CHROMEBOOKConsumer generated the click using a Google Chromebook.
UNKNOWNThe DeviceFamily could not be tracked.

Browser enum

What web browser the customer used to perform the step. Only a sample of all enum values are presented below.

View possible enum values
CHROMEConsumer generated the click using Google Chrome.
CHROME_MOBILEConsumer generated the click using Google Chrome on a mobile device.
UC_BROWSERConsumer generated the click using UC Browser.
OPERAConsumer generated the click using Opera.
OPERA_MOBILEConsumer generated the click using Opera on a mobile device.
EDGEConsumer generated the click using Microsoft Edge.
FIREFOXConsumer generated the click using Mozilla Firefox.
SAFARIConsumer generated the click using Apple's Safari browser.
CAKEConsumer generated the click using the mobile browser Cake.
AMAZON_SILKConsumer generated the click using Amazon's web browser, Silk.
UNKNOWNThe Browser could not be tracked.

Os enum

Which operating system the customer used when they performed the step. Only a sample of all enum values are presented below.

View possible enum values
ANDROIDConsumer generated the click using the Android operating system.
LINUXConsumer generated the click using the Linux operating system.
IOSConsumer generated the click using the iOS operating system.
WINDOWS_10Consumer generated the click using the Windows 10 operating system.
WINDOWS_7Consumer generated the click using the Windows 7 operating system.
UNKNOWNThe Os could not be tracked.

ProfileId string

Id of the conversion path that the customer who performed the last action took.

Fingerprint string

A unique identifier that can be used to help assign conversion path actions to the correct referrer.

Platform string

Marketing or ad display platform that manages where an ad is displayed.

DealName string

Name of the deal associated with the ad. Will be null if the ad has no associated deal.

DealType string

Type of the deal associated with the ad. Will be null if the ad has no associated deal.

DealScope string

Scope of the deal associated with the ad. Will be null if the ad has no associated deal.

SubId1 string

General SubId field that accepts strings of any SubIds you want to send. Appears in your reports.

SubId2 string

General SubId field that accepts strings of any SubIds you want to send. Appears in your reports.

SubId3 string

General SubId field that accepts strings of any SubIds you want to send. Appears in your reports.

SharedId string

General SharedId field that accepts strings of any SharedIds you want to send. Appears in your reports.

AppPackageName string

Name of the associated app package.

AppName string

Name of the app installed by the customer.

AppVersion string

Version of the app installed by the customer.

PhoneNumber string

Customer's phone number.

Oid string

Id of the customer's order.

PromoCode string

Promo code used by the customer.

OrderMargin decimal

Profit margin of the order.

OrderDiscount decimal

Total discount the customer received in the order.

OrderShipping decimal

Shipping and handling fees of the order.

OrderTax decimal

Sales tax of the order.

OrderVAT decimal

Value-Added Tax of the order. See which countries have VAT.

OrderSubTotal decimal

What the order cost before any taxes or fees are added onto it.

Note string

Additional information related to the conversion path step.

Text1 string

General text field that accepts strings of any text data you want to send. Appears in your reports.

Text2 string

General text field that accepts strings of any text data you want to send. Appears in your reports.

Text3 string

General text field that accepts strings of any text data you want to send. Appears in your reports.

Numeric1 decimal

General numeral field that accepts strings of any numeric data you want to send. Appears in your reports.

Numeric2 decimal

General numeral field that accepts strings of any numeric data you want to send. Appears in your reports.

Numeric3 decimal

General numeral field that accepts strings of any numeric data you want to send. Appears in your reports.

Money1 decimal

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Money2 decimal

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Money3 decimal

General numeral field that accepts strings of any money or financial data you want to send. Appears in your reports.

Date1 string

General date field that accepts strings of dates and times you want to send. Appears in your reports. See ISO 8601.

Date2 string

General date field that accepts strings of dates and times you want to send. Appears in your reports. See ISO 8601.

Date3 string

General date field that accepts strings of dates and times you want to send. Appears in your reports. See ISO 8601.

ReferralCounts array

General referral information (listed as separate objects) associated with the conversion path. Will be empty if no referrals took place in the conversion path.

View child attributes

Type enum

Legacy value denoting the internal type associated with the referral.

Possible enum values
Click
Call
Promocode
Action
Reported_Partner_Id
Impression
Action_Inquiry

Count integer

How many referrals are present in the conversion path.

{
  "ModelId": "999",
  "ModelName": "Algorithmic",
  "CampaignId": "1000",
  "CampaignName": "ACME Campaign",
  "Latency": "0.0",
  "Steps": "1",
  "Revenue": "92.1",
  "Cost": "0.0",
  "MediaCount": "1",
  "ChannelCount": "1",
  "ReferralCounts": [],
  "CustomerId": "79824Y",
  "Events": {
    "Event": {
      "Id": "E-A.1234.a5678901-234b-5c67-8d9e-01234f56g",
      "Type": "Conversion",
      "SubType": "MOBILE_APP",
      "EventDate": "2021-01-25T08:52:23-05:00",
      "Step": "",
      "PositionType": "",
      "SiteVersion": "",
      "SiteCategory": "",
      "LandingPage": "",
      "CustomerStatus": "existing",
      "CustomerPostCode": "93107",
      "CustomerArea": "999",
      "CustomerCity": "Santa Barbara",
      "CustomerRegion": "CA",
      "CustomerCountry": "US",
      "DeviceType": "DESKTOP",
      "DeviceFamily": "Chromebook",
      "Browser": "",
      "Os": "Chrome OS",
      "ProfileId": "",
      "Fingerprint": "",
      "Platform": "",
      "MediaId": "",
      "MediaName": "",
      "Channel": "",
      "AdDistributionType": "",
      "AdCampaign": "",
      "AdGroup": "",
      "AdId": "",
      "AdName": "",
      "AdType": "",
      "DealName": "",
      "DealType": "",
      "DealScope": "",
      "Keyword": "",
      "MatchType": "",
      "TrafficType": "",
      "AdSiteLocation": "",
      "SubId1": "",
      "SubId2": "",
      "SubId3": "",
      "SharedId": "",
      "ReferringUrl": "",
      "AttributedCredit": "",
      "AttributedRevenue": "",
      "ActionId": "A.1234.a5678901-234b-5c67-8d9e-01234f56g",
      "ActionDate": "2021-01-25T08:52:23-05:00",
      "ActionTrackerId": "4000",
      "ActionTrackerName": "Install (Android App)",
      "AppPackageName": "",
      "AppName": "",
      "AppVersion": "",
      "PhoneNumber": "",
      "Oid": "O7777777",
      "PromoCode": "",
      "Amount": "92.1",
      "Payout": "0.0",
      "OrderMargin": "0.0",
      "OrderDiscount": "",
      "OrderShipping": "",
      "OrderTax": "",
      "OrderVAT": "",
      "OrderSubTotal": "",
      "Note": "",
      "Text1": "",
      "Text2": "",
      "Text3": "",
      "Numeric1": "",
      "Numeric2": "",
      "Numeric3": "",
      "Money1": "",
      "Money2": "",
      "Money3": "",
      "Date1": "",
      "Date2": "2016-07-28T20:00:00-04:00",
      "Date3": ""
      }
    }
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Models/999/ConversionPaths/E-A.1234.a5678901-234b-5c67-8d9e-01234f56g"
}