The following article defines each field on each API endpoint. For more information on the data points shared see the PathFactory REST API on swagger.
Visitors
Endpoint: session /public/v1/visitor_ids
Description: Visitors are those who have visited any of the PathFactory VEX or Campaign Tools experiences you’ve built. This endpoint provides information about the visitor – their email address, their unique ID in PathFactory, and their unique ID in the Marketing Automation Platform (MAP) if your instance is integrated with an MAP platform – Pardot, Eloqua or Hubspot
Field Name | Type | Description |
---|---|---|
updated_at_utc |
date/time |
The date and time at which the contact record was last updated – new email address, new MAP ID, etc |
platform_contact_id |
string |
The unique identifier that the contact’s record has in the MAP platform |
platform |
string |
The name of the MAP platform that the ID was obtained from – Eloqua, Marketo or Pardot |
id |
integer/number |
PathFactory unique numeric visitor id. It corresponds to a unique visitor record in the PathFactory database. |
email_domain |
string |
The domain of the email address of the visitor who engaged with content served via PathFactory. The visitor has to be known in PathFactory in order for this field to have a value. |
|
string |
The email address of the visitor who engaged with content served via PathFactory. The visitor has to be known in PathFactory in order for this field to have a value. |
created_at_utc |
string |
The date and time at which a record for the contact that connects their PathFactory ID with their MAP ID was created |
Anonymize Visitors
Endpoint: session /public/v1/delete_visitors
Description: Deletes a list of visitors that you provide the PathFactory visitor IDs for
Visitor Activity
Endpoint: session /public/v1/visitor_activities
Description: Clients have the option to create “Visitor Activities” in PathFactory. These visitor activities trigger when the visitor performs the actions set in the activity.
Examples:
- Engage with a specific asset for x number of seconds.
- Views x number of assets in a content track for x number of seconds.
Field Name | Type | Description |
---|---|---|
visitor_id |
integer/numeric |
PathFactory unique numeric visitor id. It corresponds to a unique visitor record in the PathFactory database. |
session_id |
string |
A string of digits separated by hyphens that represent a unique engagement session in PathFactory |
experience_id |
integer/numeric |
The PathFactory system-generated ID for the recommend,target or landing experience |
activity_type |
string |
The type of activity that is published. Example: “Engagement_Score” |
activity_time |
date/time |
The date and time at which the activity was triggered |
activity_name |
string |
The name of the activity as it was set up in PathFactory |
Sessions
Endpoint: Sessions /public/v1/sessions
Description: A session in PathFactory represents a period of time during which a visitor engages with content served via PathFactory. A session begins when the visitor loads a resource created via PathFactory and ends 30mins after the visitor stops engaging with that resource. The visitor could stop engaging with a PathFactory content resource in one of the following ways:
- They close the browser tab that has the PathFactory track, explore page, VEX session or webpage that has the PathFactory Jukebox Script running on it
- They keep the browser tab open but turn it into a background tab and do not make it the active tab in 30 minutes
- They keep the tab open but step away from their computer, tablet or mobile device for longer than 30 minutes
Field Name | Type | Description |
---|---|---|
visitor_id |
integer/numeric |
PathFactory unique numeric visitor id. It corresponds to a unique visitor record in the PathFactory database. |
utm_source |
string |
The value associated with the utm_source parameter if one was present in the PathFactory Asset URL during the engagement session |
utm_term |
string |
The value associated with the utm_source parameter if one was present in the PathFactory Asset URL during the engagement session |
utm_medium |
string |
The value associated with the utm_source parameter if one was present in the PathFactory Asset URL during the engagement session |
utm_campaign |
string |
The value associated with the utm_source parameter if one was present in the PathFactory Asset URL during the engagement session |
utm_content |
string |
The value associated with the utm_source parameter if one was present in the PathFactory Asset URL during the engagement session |
unique_views |
integer/numeric |
The number of unique assets that were viewed in an engagement session |
total_asset_views |
integer/numeric |
The total number of asset views that were recorded during the engagement session. |
start_time |
date/time |
The date and time at which the engagement session started. |
shares |
integer/numeric |
The number of times a track has been shared using one of the Social Media sharing buttons available in PathFactory tracks – LinkedIn, Twitter |
session_id |
string |
A string of digits separated by hyphens that represent a unique engagement session in PathFactory |
region |
string |
The geographic region of the visitor based on their IP |
referrer_url |
string |
If the visitor arrived on the content track by clicking on a link in a web page, the URL of the page will show here. This will be blank for visitors coming from emails. |
query_string |
string |
The full value of the query string (everything after ‘?’ in the URL) which was present in the URL during the visitor’s session. Query string values are maintained throughout a session in Pathfactory, so the same query string will be present on every asset a visitor views during a session. |
os |
string |
The operating system of the device that the visitor is using to view the content track (e.g. Windows. Mac, Android) |
likes |
integer/numeric |
The number of times the PathFactory heart button “like” was clicked in an engagement session. This button is rarely used |
experience_type |
string |
The type of the PathFactory Experience the visitor engaged with – recommend, target or landing |
experience_name |
string |
The name of the content track the visitor engaged with |
experience_id |
integer/numeric |
The PathFactory system-generated ID for the recommend,target or landing experience |
experience_external_id |
string |
The unique string value a user can associate with a track |
engagement_time |
integer/numeric |
The number of seconds a visitor spent engaging with a content track in an engagement session. |
engagement_score |
integer/numeric |
The numerical PathFactory score value that is associated with a visitor engagement session and which represents their level of engagement during the session. The score a visitor can receive is configured by the PathFactory admin(s) |
end_time |
date/time |
The date and time at which the engagement session ended. |
email_domain |
string |
The domain of the email address of the visitor who engaged with content served via PathFactory. The visitor has to be known in PathFactory in order for this field to have a value. |
email_address |
string |
The domain of the email address of the visitor who engaged with content served via PathFactory. The visitor has to be known in PathFactory in order for this field to have a value. |
domain |
string |
The ISP name associated with the visitor engagement session. This value is derived from the visitor’s IP |
device_type |
string |
The device the visitor used to engage with the PathFactory content. |
country |
string |
The country that the visitor is located in at the time they engaged with the content served via PathFactory. This is derived from the IP address of the visitor |
company_name |
string |
We attempt to associate a company name with the visitor based off their IP address used when engaging with the content served via PathFactory |
city |
string |
The city that the visitor is determined to be located at when they engaged with the content served via PathFactory. This is derived from the IP address of the visitor |
browser |
string |
The web-browser the visitor used to engage with the content served via PathFactory |
user_agent |
string |
|
Page Views
Endpoint: Sessions /public/v1/page_views
Description: A page view in PathFactory is captured when a visitor views an asset inside a content track. Sessions can contain multiple page views.
Field Name | Type | Description |
---|---|---|
utm_content |
string |
The value associated with the utm_content parameter if one was present in the PathFactory Asset URL during the engagement session |
content_topics |
string |
Returns a comma delimited list of the topic tags applied to this asset in the content library. (e.g. [” ABM”,” Sales Enablement”] ) |
start_time |
date/time |
The date and time at which the visitor landed on the page. |
content_title |
string |
The public title of the asset as set in the content library. |
browser |
string |
The operating system of the device that the visitor is using to view the content track |
utm_source |
string |
The value associated with the utm_source parameter if one was present in the PathFactory Asset URL during the engagement session |
os |
string |
The browser that the visitor is using to view the content track (e.g. Safari, Chrome) |
utm_campaign |
string |
The value associated with the utm_campaign parameter if one was present in the PathFactory Asset URL during the engagement session |
content_internal_title |
string |
The internal title of the asset as set in the content library. |
url |
string |
The PathFactory URL of the asset being viewed within the content track |
experience_external_id |
string |
This is an optional value that a PathFactory user can enter in the Content Track Configurations. If a value is entered to the External ID field, it will appear through this data point. |
city |
string |
The city that visitor is in based on their IP |
utm_medium |
string |
The value associated with the utm_medium parameter if one was present in the PathFactory Asset URL during the engagement session |
session_id |
string |
A string of digits separated by hyphens that represent a unique engagement session in PathFactory |
region |
string |
The geographic region that visitor is in based on their IP. This will be the state or province for visitors in North America |
content_id |
integer/numeric |
The unique numeric ID used to identify the piece of content being viewed in PathFactory |
experience_id |
integer/numeric |
The unique numeric ID used to identify the content track being viewed in PathFactory |
content_source_url |
string |
The underlying Asset Source URL that the content asset had prior to uploading it to the Content Library in PathFactory |
query_string |
string |
The full value of the query string (everything after ‘?’ in the URL) which was present in the URL during the visitor’s session. Query string values are maintained throughout a session in Pathfactory, so the same query string will be present on every asset a visitor views during a session. |
device_type |
string |
The device the visitor used to engage with the PathFactory content. |
content_business_units |
string |
Returns a comma delimited list of the Business Unit tags applied to this asset in the content library. |
referrer_url |
string |
If the visitor arrived on the content track by clicking on a link in a web page, the URL of the page will show here. This will be blank for visitors coming from emails. |
content_language |
string |
The language of the content asset as set in the content library. |
country |
string |
The country that visitor is in based on their IP |
content_funnel_stages |
string |
Returns a comma delimited list of the Funnel Stage applied to this asset in the content library. (e.g. [” Top of Funnel”,”Middle of Funnel”] ) |
company_name |
string |
We attempt to associate a company name – using 6Sense, with the visitor based off their IP address used when engaging with the content served via PathFactory |
content_media_type |
string |
The type of asset as detected by PathFactory (e.g. webpage, video, pdf) |
visitor_id |
integer/numeric |
The unique numeric ID used to identify the visitor in PathFactory |
engagement_time |
integer/numeric |
The amount of time in seconds that the visitor spent on the page |
utm_term |
string |
The value associated with the utm_term parameter if one was present in the PathFactory Asset URL during the engagement session |
domain |
string |
The ISP name associated with the visitor engagement session. This value is derived from the visitor’s IP |
content_external_id |
string |
External ID of the content as defined by the author. For example, this may contain a CRM campaign ID |
experience_name |
string |
The name of the content track that this page view occurred in |
Content Tracks
Endpoint: Sessions /public/v1/experiences
Description: Content tracks in PathFactory were previously named Experiences and have now been renamed as Content Tracks. A content track is a collection of content that has been added to your PathFactory’s content library. There are 2 types of content tracks: Target and Recommend.
- Target Tracks are collections of content that you have selected and organized in order to give your visitors a specific content journey.
- Recommend Tracks are collections of content specifically selected by you, and which rely on machine-learning to suggest the ideal content to show your prospects based on what they are already viewing.
Response Fields
* indicates fields that will always return a value, otherwise may contain null
Field Name | Type | Description |
---|---|---|
created_at_utc* |
string($date) |
Date Created of Content Track in UTC |
experience_custom_url |
string |
Custom url of content track if defined by the author |
experience_id* |
integer |
PathFactory generates a unique ID whenever a content track is created. |
experience_name* |
string |
Content track name as defined by the author |
experience_type* |
string |
Content track type, values may be target or recommend |
external_id |
string |
External ID of content track as defined by the author. For example, this may contain a CRM campaign ID |
is_bottom_bar_enabled* |
boolean |
Is bottom bar promoter enabled by the author? Bottom bar is a collapsible content menu along page bottom. Available only for Target content tracks. |
is_capture_enabled* |
boolean |
Is form capture enabled by the author? A content track may have a form strategy to display a form after a defined measure of time on a track or certain content assets. |
is_cookie_message_enabled* |
boolean |
Is cookie message to warn that the track uses cookies enabled by the author? |
is_end_enabled* |
boolean |
Is end promoter enabled by the author? End promoter displays a link that appears on the final asset that opens an author defined link in a new tab. Available only for Target content tracks. |
is_exit_enabled* |
boolean |
Is exit promoter enabled by the author? Exit promoter is a content window that appears when the visitor tries to navigate away from the Content Track. |
is_flow_enabled* |
boolean |
Is flow promoter enabled by the author? Flow is a scrollable content menu that allows visitors to jump ahead in their Content Track, or simply use the Next buttons to move forward. Available only for Target content tracks. |
is_gdpr_cookie_consent_enabled* |
boolean |
Is cookie consent prompt to allow or deny cookies enabled by the author? |
is_header_enabled* |
boolean |
Is header promoter enabled by the author? The Header promoter displays your logo and the sharebar above the content asset. |
is_inactivity_enabled* |
boolean |
Is inactivity promoter enabled by the author? The inactivity promoter flashes an author defined message on the title portion of the browser window/tab if the visitor left the window/tab after a defined period. |
is_like_enabled* |
boolean |
Is like button on the share bar enabled by the author? Visitors to the content track that has the share bar promoter enabled may leave a Like for the content asset they are viewing. |
is_share_enabled* |
boolean |
Is share bar enabled by the author? The share bar allows visitors to share the current content asset being viewed to their social media network such as Facebook, LinkedIn, Twitter or email. |
is_sidebar_enabled* |
boolean |
Is sidebar promoter enabled by the author? The Sidebar is a scrollable content menu allows visitors to jump ahead in their Content Track. Available only for Recommend content tracks. |
is_signpost_enabled* |
boolean |
Is signpost promoter enabled by the author? Signposts are are customizable Next and Previous buttons allow visitors to navigate through content. Available only for Target content tracks. |
is_topic_sidebar_enabled* |
boolean |
Is topic sidebar promoter enabled by the author? The Topic Sidebar is a scrollable content menu displays topic tags on content, allowing visitors to filter by topics of interest. Available only for Recommend content tracks. |
target_content_order* |
json |
A json array containing a list of content asset ID’s in the order they appear in the target track |
updated_at_utc* |
string($date) |
Last updated date of Content Track in UTC |
Content Track Assets
Endpoint: Sessions /public/v1/experiences_contents
Description: Content tracks in PathFactory were previously named Experiences and have now been renamed as Content Tracks. A content track is a collection of content assets that have been added to your PathFactory’s content library. There are 2 types of content tracks: Target and Recommend. This endpoint returns the relationship between the content track and the content.
Response Fields
* indicates fields that will always return a value, otherwise may contain null
Field Name | Type | Description |
---|---|---|
target_delay* |
integer |
Total seconds to delay Signpost promoter from appearing on content track asset. |
target_content_order* |
json |
JSON array content full list of Target content track asset order. |
is_capture_enabled* |
boolean |
PathFactory allows you to have multiple assets serve forms within a single content track. |
experience_id* |
integer |
PathFactory generates a unique ID whenever a content track is created. |
experience_content_id* |
integer |
PathFactory generates a Content Track Asset ID to record the relationship between a content track and a content asset. A content asset may be linked to many content tracks. |
content_id* |
integer |
PathFactory generates a unique ID whenever a content asset is created. |
Content Metadata
Endpoint: session public/v1/content_metadata
Description: The metadata associated with the content assets within your PathFactory content library.
Field Name | Type | Description |
---|---|---|
content_metadata_id |
integer |
PathFactory generates a unique metadata ID whenever a content asset is created. |
metadata_field |
string |
This represents the metadata fields associated with the content asset. |
metadata_value |
string |
This represents the value associated with the metadata field. This value is entered manually by the user. |
content_type |
integer |
Content Type is one of the available Content Tags used to categorize your content assets. Using this tag helps you understand what type of content your visitors engage with. Content types can include things like white papers, data sheets, videos, etc. |
content_id |
integer |
PathFactory generates a unique ID whenever a content asset is created. |
Content Assets
Endpoint: session /public/v1/content_assets
Description: Content assets are the content pieces you upload to PathFactory to show your visitors.
Field Name | Type | Description |
---|---|---|
updated_at_utc |
date/time |
Last updated date of Content Asset in UTC |
title |
integer |
The public title of the content asset. The content title can be set when a piece of content is uploaded to the Content Library. |
source_url |
string |
The URL of the underlying source content of the content asset. |
slug |
string |
The custom slug of the content asset. |
media_type |
integer |
The media type is detected by our platform when a content asset is uploaded. |
language |
string |
The language of the content asset. If you are supporting multiple languages, you will need to have a forward facing name in the relevant language, but will ideally want an internal name that is in English (or whatever your default language is internally). The Public Title/Internal Name allows you to have that functionality, making the use of multiple languages easier and more practical. |
internal_title |
string |
The name of the asset which is only visible within your instance, and will not be seen by the public. |
external_id |
string |
The external ID of the content asset. |
description |
string |
The description of the content asset. |
created_at_utc |
date/time |
Date of when the content assets was uploaded in UTC |
content_type |
string |
Content Type is one of the available Content Tags used to categorize your content assets. Using this tag helps you understand what type of content your visitors engage with. Content types can include things like white papers, data sheets, videos, etc. |
content_id |
integer |
PathFactory generates a unique ID whenever a content asset is created. |