The PathFactory REST API is a tool that enables you to integrate and interact with the PathFactory platform and access essential audience and engagement data related to visitor activities, sessions, content experiences, and content assets. This article provides details on the fields and definitions for API v1, and new v3 features that further enhance the capabilities of PathFactory’s public API.
How do I know which version of the API to use?
The API version number corresponds to the PathFactory Data Model version – therefore API v1 is built according to PathFactory’s Version 1 Data Model, and API v3 is built according to PathFactory’s Version 3 Data Model.
PathFactory Tracks, Explore, and Virtual Event Experiences (VEX) use the Version 1 Data Model – therefore this data is only available in the API v1.
PathFactory Microsites, Themes & Templates, and Website Experiences use the Version 3 Data Model – therefore this data is only available in the API v3.
API V3 Field Definitions
V3 introduces several new fields and revised definitions that improve overall developer experience and provide significant enhancements that enable more powerful integrations between PathFactory and other software applications.
OAuth 2.0 Authentication and Role-Based API Keys Now Available
In V3, the authentication process has been revamped to provide better security and flexibility. Developers can now use OAuth 2.0 for improved authorization and access control. Additionally, API keys are now issued with role-based access, allowing different levels of permissions for various endpoints.
More Request Parameters
V3 includes a wider range of request parameters to enable more precise and customized data retrieval. Developers can utilize filters, sorting options, and time-based queries to fetch the exact data they need from the API.
Response Format Standardization on JSON With More Metadata
With V3, the response format has been standardized to JSON, allowing for more straightforward parsing and processing of data. Moreover, the response now includes additional metadata, such as pagination information, providing developers with insights into the structure and size of the dataset.
Rate Limiting and Quotas
To ensure fair usage and prevent security/privacy abuse, V3 introduces rate limiting and quotas. Developers can now make a limited number of requests per unit of time, depending on their subscription tier or user level.
Webhooks
V3 introduces support for webhooks, enabling real-time updates and notifications to client applications when specific events occur within the API. This feature eliminates the need for frequent polling and improves efficiency. To find out more about PathFactory webhooks, read Setting Up Webhooks.
V3 API Endpoints and Descriptions
This section describes all of the endpoints for API V3, along with the fields and their definitions.
Content Assets
Endpoint: /public/v3/content_assets
Description: The endpoint provides essential functionalities for content management, enabling you to deliver engaging and dynamic content experiences to your users. This endpoint lets you manage individual content pieces, such as videos, PDFs, images, and interactive elements, within the system. Through this endpoint, you can create, retrieve, update, and delete content assets, empowering you to organize, curate, and optimize content.
| Field Name | Type | Description |
|---|---|---|
| content_id | integer | A numeric ID of the content asset |
| content_type | string | The file type of the asset |
| created_at_utc | timestamp | Timestamp of when the asset was created/added to the Library |
| description | string | The description of the content asset, user defined in the Library |
| external_id | string | A string with the user defined value of the content asset’s external ID |
| internal_title | string | The title of the asset, as it appears in the Library |
| language | string | The language of the content asset |
| media_type | string | The file type of the asset |
| slug | string | The slug of the asset URL |
| source_url | string | The full source URL of the content asset |
| thumbnail | string | Source URL of the asset thumbnail |
| title | string | The title of the asset, as it appears to visitors on the consumption side |
| updated_at_utc | timestamp | Timestamp of when the asset was last modified/updated in the Library |
| uuid | string | The universal ID of the content asset |
Content Metadata
Endpoint: /public/v3/content_metadata
Description: This endpoint allows you to manage the information and details associated with individual content assets. This includes data such as title, description, tags, categories, and other relevant metadata. By using this endpoint, you can create, retrieve, update, and delete content metadata, enabling you to organize, categorize, and optimize the content assets within the system.
| Field Name | Type | Description |
|---|---|---|
| content_id | integer | A numeric ID of the content asset |
| content_metadata_id | integer | A numeric ID of the content metadata tag |
| content_type | integer | The content marketing classification of the type of asset |
| metadata_field | string | The type/category of content metadata tag |
| metadata_value | string | The value/field of the content metadata tag |
| org_uuid | string | A unique ID for your PathFactory instance |
| thumbnail | string | Source URL of the asset thumbnail |
Content Track Assets
Endpoint: /public/v3/content_track_asset
Description: The endpoint provides essential functionalities for curating content, optimizing user journeys, and achieving desired engagement and conversion objectives.
| Field Name | Type | Description |
|---|---|---|
| capture_enabled | boolean | Does the Track (Experience) have a form capture configured? (T/F) |
| content_id | integer | A numeric ID of the content asset |
| experience_content_id | integer | A numeric ID of the content asset and Track |
| experience_id | integer | A numeric ID of the Track (Experience) |
| experience_uuid | string | A universal ID of the Track (Experience) |
| target_content_order | json | A JSON array/list of the order of content assets in a Target Track by ID |
| target_delay | integer | The number of seconds configured before the sign post/card modal is shown |
| thumbnail | string | Source URL of the asset thumbnail |
| uuid | string | A unique ID of the content asset and Track |
Content Tracks
Endpoint: /public/v3/content_track
Description: This endpoint enables you to create, retrieve, update, and delete Standard Experiences.
| Field Name | Type | Description |
|---|---|---|
| app_id | string | A unique ID for your PathFactory instance |
| created_at_utc | timestamp | Timestamp (in UTC) of when the Track (Experience) was created/added to the Library |
| experience_custom_url | string | User defined custom URL for the Track (Experience) |
| experience_id | integer | A numeric ID of the Track (Experience) |
| experience_name | string | Title of the Track (Experience) as it appears within PathFactory (internally) |
| experience_type | string | The type of PathFactory Experience |
| experience_uuid | string | A universal ID of the Track (Experience) |
| external_id | string | A string with the user defined value of the Experience’s external ID |
| is_bottom_bar_enabled | boolean | Is the Track (Experience) configured with a bottom bar? (T/F) |
| is_capture_enabled | boolean | Does the track (Experience) have a form capture configured? (T/F) |
| is_card_enabled | boolean | Is the Track (Experience) configured with a card? (T/F) |
| is_cookie_consent_enabled | boolean | Does the track (Experience) show the consent message? (T/F) |
| is_cookie_message_enabled | boolean | Does the track (Experience) show the cookie message? (T/F) |
| is_end_enabled | boolean | Does the track (Experience) have the end promoter configured? (T/F) |
| is_exit_enabled | boolean | Does the track (Experience) have the exit promoter configured? (T/F) |
| is_flow_enabled | boolean | Is the track (Experience) configured as “Flow” style? (T/F) |
| is_gdpr_cookie_consent_enabled | boolean | Does the track (Experience) show the GDPR consent message? (T/F) |
| is_header_enabled | boolean | Does the track (Experience) show the configured header? (T/F) |
| is_inactivity_enabled | boolean | Does the track (Experience) have the inactivity promoter configured? (T/F) |
| is_like_enabled | boolean | Does the track (Experience) show the “like” button? (T/F) |
| is_share_enabled | boolean | Does the track (Experience) have the sharing buttons? (T/F) |
| is_sidebar_enabled | boolean | Is the Track (Experience) configured with a side bar layout? (T/F) |
| is_signpost_enabled | boolean | Is the Track (Experience) configured with a signpost/card? (T/F) |
| is_topic_sidebar_enabled | boolean | Is the Track (Experience) configured with the topic tags display? (T/F) |
| target_content_order | string | A JSON array/list of the order of content assets in a Target Track by ID |
| updated_at_utc | date/time | Timestamp (in UTC) of when the Track (Experience) was last modified/updated |
Page Views
Endpoint: /public/v3/pageviews
Description: Page views are captured when a visitor views an asset inside a PathFactory Experience.
| Field Name | Type | Description |
|---|---|---|
| page_view_id | string | Unique ID for the page view |
| app_id | string | A unique ID for your PathFactory instance |
| visitor_id | string | A numeric ID of the visitor |
| visitor_uuid | string | A universal ID of the visitor |
| session_id | string | The PathFactory ID of the visit (session) |
| session_index | integer | An index of the visit (session) for the visitor; ie, 1 would be the first visit, 2 the second visit, n the nth visit |
| page_view_index | integer | An index of the view within the visit (session); ie, 1 would be the first view, 2 the second view, n the nth view |
| total_page_views | integer | The total number of asset views in the visit (session) |
| _modified_utc | timestamp | The system timestamp (in UTC) indicating when the data was last modified |
| created_at | timestamp | The timestamp (in UTC) indicating when the page view was created |
| start_time | timestamp | The timestamp of the view (user’s locale) |
| start_time_utc | timestamp | The timestamp of the view (in UTC) |
| end_time_utc | timestamp | The timestamp when the view ended (in UTC) |
| engaged_time_in_s | integer | The duration (in seconds) of the engagement time |
| content_uuid | string | The universal ID of the content asset |
| experience_uuid | string | A universal ID of the Track (Experience) |
| content_id | integer | A numeric ID of the content asset |
| experience_id | integer | A numeric ID of the Track (Experience) |
| vertical_percentage_scrolled | integer | The maximum vertical scroll of the view (in percentage) |
| page_width | integer | The width of the page (in pixels) |
| page_height | integer | The height of the page (in pixels) |
| page_title | string | The page title |
| page_url | string | The URL of the page |
| query_string | string | The full query string from the URL of the view |
| page_urlquery | string | The full query string from the URL of the view |
| marketing_medium | string | The value of the marketing (eg, UTM) Medium parameter of the view |
| marketing_source | string | The value of the marketing (eg, UTM) Source parameter of the view |
| marketing_term | string | The value of the marketing (eg, UTM) Term parameter of the view |
| marketing_content | string | The value of the marketing (eg, UTM) Content parameter of the view |
| marketing_campaign | string | The value of the marketing (eg, UTM) Campaign parameter of the view |
| page_referrer | string | The URL that referred the view |
| referrer_medium | string | The identified Medium value of the referring URL (eg, “search”) |
| referrer_source | string | The identified Source type value of the referring URL (eg, “DuckDuckGo”) |
| referrer_term | string | The identified Term value of the referring URL |
| ip_address | string | IP address of the visitor for the view |
| browser | string | The identified browser of the view |
| spider_or_robot | boolean | Is the visitor of the view an identified Spider or robot? (T/F) |
| os | string | The identified Operating System (OS) of the view |
| device_type | string | The category of the identified device of the visit |
| from_recommendation | boolean | Is the view from PathFactory’s Recommendation system? (T/F) |
| rec_mdm_guide | boolean | Is the view from PathFactory’s Recommendation “Guide” promoter? (T/F) |
| rec_mdm_concierge | boolean | Is the view from PathFactory’s Recommendation “Concierge” promoter? (T/F) |
| rec_src_recommended | boolean | Is the view from PathFactory’s “Recommended for You” Recommendation type? (T/F) |
| rec_src_trending | boolean | Is the view from PathFactory’s “Trending” Recommendation type? (T/F) |
| referrer_url | string | The page URL of the referrer |
| ip_isp | string | The visitor’s Internet Service Provider (ISP) as determined by the identified Internet Protocol (IP) address of the view |
| sixsense_company_domain | string | Identified company/account domain (URL) from 6sense |
| sixsense_company_name | string | Identified company/account name from 6sense |
| sixsense_company_region | string | Identified company/account’s region (geolocation) from 6sense |
| sixsense_company_country | string | Identified company/account’s country (geolocation) from 6sense |
| sixsense_company_country_iso_code | string | Identified company/account’s country (geolocation), ISO code, from 6sense |
| sixsense_company_state | string | Identified company/account’s state (geolocation) from 6sense |
| sixsense_company_city | string | Identified company/account’s city (geolocation) from 6sense |
| sixsense_company_street_address | string | Identified company/account’s address (geolocation) from 6sense |
| sixsense_company_postal_code | string | Identified company/account’s postal code (geolocation) from 6sense |
| sixsense_company_phone | string | Identified company/account’s phone number from 6sense |
| sixsense_company_industry | string | Identified company/account’s industry type number from 6sense |
| sixsense_company_employee_range | string | Identified company/account’s employee size by range from 6sense |
| sixsense_company_revenue_range | string | Identified company/account’s revenue size by range from 6sense |
| sixsense_company_employee_count | string | Identified company/account’s employee size by count from 6sense |
| sixsense_company_annual_revenue | string | Identified company/account’s revenue size by count from 6sense |
| sixsense_company_title_level | string | Identified job title and level of the visitor from 6sense |
| sixsense_company_title_function | string | Identified job function of the visitor from 6sense |
| sixsense_company_siccode | string | Identified company/account’s SIC industry code from 6sense |
| sixsense_company_sicdescription | string | Identified company/account’s SIC industry description from 6sense |
| sixsense_company_naicscode | string | Identified company/account’s NAICS industry code from 6sense |
| sixsense_company_naicsdescription | string | Identified company/account’s NAICS industry description from 6sense |
| sixsense_company_isblacklisted | boolean | Is the identified company/account blacklisted? (T/F) |
| sixsense_confidence | string | Value of confidence level for identification, 6sense |
| experience_type | integer | A numeric ID of PathFactory Experience types |
| demandbase_sid | integer | Demandbase’s numeric ID for the identified company/account |
| demandbase_company_name | string | Identified company/account name from Demandbase |
| demandbase_annual_sales | integer | Identified company/account’s revenue size by count from Demandbase |
| demandbase_employee_count | 0 | Identified company/account’s employee size by count from Demandbase |
| demandbase_industry | string | Identified company/account’s industry type number from Demandbase |
| demandbase_web_site | string | Identified company/account website (URL) from Demandbase |
| unified_engagement_score | integer | Engagement score |
| engagement_score | integer | Engagement score |
| experience_campaign_id | string | ID for the campaign associated with the Experience |
| campaign_id | string | ID of the campaign |
| website_experience_uuid | string | A universal ID of the PathFactory Website Experience |
| ip_2_proxy_isproxy | boolean | Is the visitor’s Internet Protocol (IP) address of the view a proxy IP? (T/F) |
| normalized_url | string | Normalized URL of the page |
Sessions
Endpoint: /public/v3/sessions
Description: This endpoint tracks the time a visitor spends engaging with content served via PathFactory. It records details like the visitor’s location, the content viewed, and more.
| Field Name | Type | Description |
|---|---|---|
| session_id | string | The PathFactory ID of the visit (session) |
| app_id | string | A unique ID for your PathFactory instance |
| browser | string | The identified browser of the view |
| city | string | The identified city of the visit/session (geolocation) |
| company_name | string | The identified Company/Account name of the view |
| country | string | The identified country of the visit/session (geolocation) |
| device_type | string | The category of the identified device of the view |
| domain | string | Domain associated with the session. |
| email_address | string | The email address of the known visitor |
| email_domain | string | The domain of the known visitor’s email address |
| end_time | timestamp | The timestamp when the visit (session) ended (in visitor’s locale) |
| engagement_score | integer | The total engagement score of the visit (session) |
| engagement_time | integer | The total duration (in seconds) of the visit’s/session’s engagement time |
| experience_external_id | string | A string with the user defined value of the Experience’s external ID |
| experience_id | string | A numeric ID of the Experience |
| experience_name | string | Title of the Experience as it appears within PathFactory (internally) |
| experience_type | string | The type of PathFactory Experience |
| likes | integer | The total count of “likes” during the visit |
| os | string | The identified Operating System (OS) of the visit |
| query_string | string | The full query string from the URL of the visit |
| referrer_url | string | The full URL that referred the view |
| region | string | The identified region of the visit (geolocation) |
| shares | integer | The total count of “shares” during the visit |
| start_time | timestamp | The timestamp of the view (visitor’s locale) |
| total_asset_views | integer | The total number of asset views in the visit (session) |
| unique_views | integer | The number of unique assets views in the visit (session) |
| marketing_campaign | string | The value of the marketing (eg, UTM) Campaign parameter of the view |
| marketing_content | string | The value of the marketing (eg, UTM) Content parameter of the view |
| marketing_medium | string | The value of the marketing (eg, UTM) Medium parameter of the view |
| marketing_source | string | The value of the marketing (eg, UTM) Source parameter of the view |
| marketing_term | string | The value of the marketing (eg, UTM) Term parameter of the view |
| visitor_id | integer | A numeric ID of the visitor |
| visitor_uuid | string | A universal ID of the visitor |
| _modified_utc | timestamp | The system timestamp (in UTC) indicating when the data was last modified |
| end_time_utc | timestamp | The timestamp when the visit/session ended (in UTC) |
| start_time_utc | timestamp | UTC timestamp indicating when the session started. |
| captures | integer | The count of how many captures (ie, form submissions) occurred |
| capture_modal_shown_count | integer | The count of how many capture modals shown (ie, forms shown) |
| user_agent | string | The full “user agent” of the visitor from the visit/session |
| experience_uuid | string | A universal ID of the Track (Experience) |
Visitor Activities
Endpoint: /public/v3/visitor_activities
Description: Visitor Activities are actions triggered when a visitor performs specific actions in PathFactory. With these fields and definitions, you can better understand your visitors and their actions. It opens up opportunities to personalize content and engage visitors effectively. For example, you may want to track visitors who engage with a specific asset for a specific amount of time, or track visitors who view multiple assets in a PathFactory Experience for a specific duration.
| Field Name | Type | Description |
|---|---|---|
| activity_name | string | The name of the activity as it was set up in PathFactory |
| activity_time | timestamp | The timestamp when the activity was triggered |
| activity_type | string | The type of activity that is published (eg, Engagement_Score) |
| experience_id | integer | A numeric ID of the Track (Experience) |
| organization_id | integer | A numeric ID for your PathFactory instance |
| session_id | string | The PathFactory ID of the visit (session) |
| visitor_id | integer | A numeric ID of the visitor |
Visitors
Endpoint: /public/v3/visitors
Description: This endpoint provides information about visitors who have navigated to your website or PathFactory Experience, allowing for the retrieval of visitor-related data, enabling insights into their engagement, identity, and interactions within the website or PathFactory Experience.
| Field Name | Type | Description |
|---|---|---|
| app_id | string | A unique ID for your PathFactory instance |
| created_at_utc | string | The timestamp (in UTC) of when the visitor record was created |
| string | The email address of the known visitor | |
| email_domain | string | The domain of the known visitor’s email address |
| first_visit_time_utc | string | The timestamp (in UTC) of the visitor record’s first visit |
| is_known | boolean | Is the visitor a known visitor? (T/F) |
| known_from | timestamp | Timestamp of when the visitor record became a known visitor |
| last_visit_time_utc | string | The timestamp (in UTC) of the visitor record’s most recent visit |
| visitor_ecid | string | Visitor’s Experience Cloud ID (if it exists and was present during PathFactory visit) |
| visitor_id | string | A numeric ID of the visitor |
| visitor_identity | string | Primary and unifying ID of the visitor record (eg, known visitors email address is their PathFactory Visitor Identity, and unknown visitor’s UUID is their PathFactory Visitor Identity) |
| visitor_uuid | string | A universal ID of the visitor |
Visitor IDs
Endpoint: /public/v3/visitor_ids
Description: Visitors are people who have interacted with the content you’ve created using PathFactory Experiences. This API endpoint provides useful information about the visitors, like their email address, unique ID in PathFactory, and their ID in the Marketing Automation Platform (MAP) if you’re using one like Pardot, Eloqua, or Hubspot. “Visitor ID” will include all visitor records that are mapped to an email, and therefore duplicate IDs may exist.
| Field Name | Type | Description |
|---|---|---|
| created_at_utc | string | The timestamp (in UTC) of when the visitor record was created |
| string | The email address of the known visitor | |
| email_domain | string | The domain of the known visitor’s email address |
| id | integer | A numeric ID of the visitor |
| organization_id | integer | A numeric ID for your PathFactory instance |
| platform | string | The name of the MAP platform that the ID was obtained from – Eloqua, Marketo or Pardot |
| platform_contact_id | string | The unique identifier that the contact’s record has in the MAP platform |
| platform_id | string | The ID of the contact record’s source platform |
| updated_at_utc | timestamp | The timestamp (in UTC) that the visitor record was last updated |
| visitor_uuid | string | A universal ID of the visitor |
Unique Visitor IDs
Endpoint: /public/v3/unique_visitor_ids
Description: Visitors are people who have interacted with the content created using PathFactory Experiences. This API endpoint provides useful information about the visitors, such as their email address, unique ID in PathFactory, and their ID in the Marketing Automation Platform (MAP) if used (e.g., Pardot, Eloqua, or HubSpot). “Unique Visitor ID” will be the most recent visitor record that’s mapped to an email, and therefore the IDs are distinct.
| Field Name | Type | Description |
|---|---|---|
| created_at_utc | timestamp | The timestamp (in UTC) of when the visitor record was created |
| string | The email address of the known visitor | |
| email_domain | string | The domain of the known visitor’s email address |
| id | integer | A numeric ID of the visitor |
| organization_id | string | A numeric ID for your PathFactory instance |
| platform | string | The name of the MAP platform that the ID was obtained from – Eloqua, Marketo or Pardot |
| platform_contact_id | string | The unique identifier that the contact’s record has in the MAP platform |
| platform_id | string | The ID of the contact record’s source platform |
| updated_at_utc | timestamp | The timestamp (in UTC) that the visitor record was last updated |
| visitor_uuid | string | A universal ID of the visitor |
V1 API Endpoints and Descriptions
Content Assets
Endpoint: /public/v1/content_assets
Description: The endpoint provides essential functionalities for content management, enabling you to deliver engaging and dynamic content Experiences to your users. This endpoint lets you manage individual content pieces, such as videos, PDFs, images, and interactive elements, within the system. Through this endpoint, you can create, retrieve, update, and delete content assets, empowering you to organize, curate, and optimize content.
| Field Name | Type | Description |
|---|---|---|
| content_id | integer | A numeric ID of the content asset |
| content_type | string | The file type of the asset |
| created_at_utc | timestamp | Timestamp of when the asset was created/added to the Library |
| internal_title | string | The title of the asset, as it appears in the Library |
| media_type | integer | A numeric ID of file types |
| slug | string | The slug of the asset URL |
| source_url | string | The full source URL of the content asset |
| thumbnail | string | Source URL of the asset thumbnail |
| title | string | The title of the asset, as it appears to visitors on the consumption side |
| updated_at_utc | timestamp | Timestamp of when the asset was last modified/updated in the Library |
Content Metadata
Endpoint: /public/v1/content_metadata
Description: This endpoint allows you to manage the information and details associated with individual content assets. This includes data such as title, description, tags, categories, and other relevant metadata. By using this endpoint, you can create, retrieve, update, and delete content metadata, enabling you to organize, categorize, and optimize the content assets within the system.
| Field Name | Type | Description |
|---|---|---|
| content_id | integer | A numeric ID of the content asset |
| content_metadata_id | integer | A numeric ID of the content metadata tag |
| content_type | string | The content marketing classification of the type of asset |
| metadata_field | string | The type/category of content metadata tag |
| metadata_value | string | The value/field of the content metadata tag |
| thumbnail | string | Source URL of the asset thumbnail |
Content Track Assets
Endpoint: /public/v1/Experiences_contents
Description: The endpoint provides essential functionalities for curating content, optimizing user journeys, and achieving desired engagement and conversion objectives.
| Field Name | Type | Description |
|---|---|---|
| content_id | integer | A numeric ID of the content asset |
| experience_content_id | integer | A numeric ID of the content asset and Track |
| experience_id | integer | A numeric ID of the Track (Experience) |
| experience_uuid | string | A universal ID of the Track (Experience) |
| is_capture_enabled | boolean | Does the Track (Experience) have a form capture configured? (T/F) |
| target_content_order | string | A JSON array/list of the order of content assets in a Target Track by ID |
| target_delay | integer | The number of seconds configured before the sign post/card modal is shown |
| thumbnail | string | Source URL of the asset thumbnail |
Content Tracks
Endpoint: /public/v1/Experiences
Description: This endpoint enables you to create, retrieve, update, and delete Standard Experiences.
| Field Name | Type | Description |
|---|---|---|
| created_at_utc | timestamp | Timestamp (in UTC) of when the Track (Experience) was created/added to the Library |
| experience_name | string | Title of the Track (Experience) as it appears within PathFactory (internally) |
| experience_id | integer | A numeric ID of the Track (Experience) |
| experience_type | integer | A numeric ID of PathFactory Experience types |
| experience_uuid | string | A universal ID of the Track (Experience) |
| external_id | string | A string with the user defined value of the Experience’s external ID |
| is_bottom_bar_enabled | boolean | Is the Track (Experience) configured with a bottom bar? (T/F) |
| is_capture_enabled | boolean | Does the track (Experience) have a form capture configured? (T/F) |
| is_card_enabled | boolean | Is the Track (Experience) configured with a card? (T/F) |
| is_cookie_message_enabled | boolean | Does the track (Experience) show the cookie message? (T/F) |
| is_end_enabled | boolean | Does the track (Experience) have the end promoter configured? (T/F) |
| is_exit_enabled | boolean | Does the track (Experience) have the exit promoter configured? (T/F) |
| is_flow_enabled | boolean | Is the track (Experience) configured as “Flow” style? (T/F) |
| is_gdpr_cookie_consent_enabled | boolean | Does the track (Experience) show the GDPR consent message? (T/F) |
| is_header_enabled | boolean | Does the track (Experience) show the configured header? (T/F) |
| is_inactivity_enabled | boolean | Does the track (Experience) have the inactivity promoter configured? (T/F) |
| is_like_enabled | boolean | Does the track (Experience) show the “like” button? (T/F) |
| is_share_enabled | boolean | Does the track (Experience) have the sharing buttons? (T/F) |
| is_sidebar_enabled | boolean | Is the Track (Experience) configured with a side bar layout? (T/F) |
| is_signpost_enabled | boolean | Is the Track (Experience) configured with a signpost/card? (T/F) |
| is_topic_sidebar_enabled | boolean | Is the Track (Experience) configured with the topic tags display? (T/F) |
| target_content_order | string | A JSON array/list of the order of content assets in a Target Track by ID |
| updated_at_utc | timestamp | Timestamp (in UTC) of when the Track (Experience) was last modified/updated |
Page Views
Endpoint: /public/v1/page_views
Description: Page views are captured when a visitor views an asset inside a content track.
| Field Name | Type | Description |
|---|---|---|
| browser | string | The identified browser of the view |
| city | string | The identified city of the view (geolocation) |
| company_name | string | The identified Company/Account name of the view |
| content_business_units | string | An array/list of the Content Business Unit tags of the asset at that point in time |
| content_external_id | string | A string with the user defined value of the content asset’s external ID at that point in time |
| content_funnel_stages | string | An array/list of the Content Funnel Stage tags of the asset at that point in time |
| content_id | integer | A numeric ID of the content asset |
| content_internal_title | string | The title of the asset, as it appears in the Library |
| content_language | string | The language of the content asset |
| content_media_type | string | The file type of the asset |
| content_source_url | string | The asset’s source URL |
| content_title | string | The title of the asset, as it appears to visitors on the consumption side |
| content_topics | string | An array/list of the Content Topic tags of the asset at that point in time |
| country | string | The identified country of the view (geolocation) |
| device_type | string | The category of the identified device of the view |
| domain | string | The URL of the identified company/account name |
| engagement_time | integer | The duration (in seconds) of the engagement time |
| experience_external_id | string | A string with the user defined value of the Track’s (Experience’s) external ID at that point in time |
| experience_id | integer | A numeric ID of the Track (Experience) |
| experience_name | string | Title of the Track (Experience) as it appears within PathFactory (internally) |
| os | string | The identified Operating System (OS) of the view |
| query_string | string | The full query string from the URL of the view |
| referrer_url | string | The URL that referred the view |
| region | string | The identified region of the view (geolocation) |
| session_id | string | The PathFactory ID of the visit (session) |
| start_time | timestamp | The timestamp of the view (user’s locale) |
| url | string | The full URL of the view |
| utm_campaign | string | The value of the UTM Campaign parameter of the view |
| utm_content | string | The value of the UTM Content parameter of the view |
| utm_medium | string | The value of the UTM Medium parameter of the view |
| utm_source | string | The value of the UTM Source parameter of the view |
| utm_term | string | The value of the UTM Term parameter of the view |
| visitor_id | integer | A numeric ID of the visitor |
| visitor_uuid | string | A universal ID of the visitor |
Sessions
Endpoint: /public/v1/sessions
Description: Sessions represent periods during which a visitor engages with content served via PathFactory.
| Field Name | Type | Description |
|---|---|---|
| browser | string | The identified browser of the visit |
| capture_modal_shown_count | integer | The count of how many capture modals shown (ie, forms shown) |
| captures | integer | The count of how many captures occurred |
| city | string | The identified city of the visit (geolocation) |
| company_name | string | The identified Company/Account name of the visit |
| country | string | The identified country of the visit (geolocation) |
| device_type | string | The category of the identified device of the visit |
| domain | string | The URL of the identified company/account name |
| email_address | string | The email address of the known visitor |
| email_domain | string | The domain of the known visitor’s email address |
| end_time | timestamp | The timestamp of when the visit ended |
| engagement_score | integer | The total engagement score of the visit |
| engagement_time | integer | The total duration (in seconds) of the visit’s engagement time |
| experience_external_id | string | A string with the user defined value of the Experience’s external ID |
| experience_name | string | Title of the Track (Experience) as it appears within PathFactory (internally) |
| experience_type | string | The type of PathFactory Experience |
| likes | integer | The total count of “likes” during the visit |
| os | string | The identified Operating System (OS) of the visit |
| query_string | string | The full query string from the URL of the visit |
| referrer_url | string | The full URL that referred the view |
| region | string | The identified region of the visit (geolocation) |
| session_id | string | The PathFactory ID of the visit (session) |
| shares | integer | The total count of “shares” during the visit |
| start_time | timestamp | The timestamp of the view (visitor’s locale) |
| total_asset_views | integer | The total number of asset views in the visit (session) |
| unique_views | integer | The number of unique assets views in the visit (session) |
| utm_campaign | string | The value of the visit’s UTM Campaign parameter |
| utm_content | string | The value of the visit’s UTM Content parameter |
| utm_medium | string | The value of the visit’s UTM Medium parameter |
| utm_source | string | The value of the visit’s UTM Source parameter |
| utm_term | string | The value of the visit’s UTM Term parameter |
| visitor_id | integer | A numeric ID of the visitor |
| visitor_uuid | string | A universal ID of the visitor |
Visitor Activities
Endpoint: /public/v1/visitor_activities
Description: Visitor Activities are actions triggered when a visitor performs specific actions in PathFactory. With these fields and definitions, you can better understand your visitors and their actions. It opens up opportunities to personalize content and engage visitors effectively. For example, you may want to track visitors who engage with a specific asset for a specific amount of time, or track visitors who view multiple assets in a content track for a specific duration.
| Field Name | Type | Description |
|---|---|---|
| activity_name | string | The name of the activity as it was set up in PathFactory |
| activity_time | timestamp | The timestamp when the activity was triggered |
| activity_type | string | The type of activity that is published (eg, Engagement_Score) |
| experience_id | integer | A numeric ID of the Track (Experience) |
| session_id | string | The PathFactory ID of the visit (session) |
| visitor_id | integer | A numeric ID of the visitor |
| visitor_uuid | string | A universal ID of the visitor |
Visitors
Unique Visitor IDs
Endpoint: /public/v1/unique_visitor_ids
Description: Visitors are people who have interacted with the content you’ve created using PathFactory’s VEX or Campaign Tools. This API endpoint provides useful information about the visitors, like their email address, unique ID in PathFactory, and their ID in the Marketing Automation Platform (MAP) if you’re using one like Marketo, Pardot, or Eloqua.
| Field Name | Type | Description |
|---|---|---|
| created_at_utc | timestamp | The timestamp (in UTC) of when the visitor record was created |
| string | The email address of the known visitor | |
| email_domain | string | The domain of the known visitor’s email address |
| id | integer | A numeric ID of the visitor |
| platform | string | The name of the MAP platform that the ID was obtained from – Eloqua, Marketo or Pardot |
| platform_contact_id | string | The unique identifier that the contact’s record has in the MAP platform |
| updated_at_utc | timestamp | The timestamp (in UTC) that the visitor record was last updated |
| visitor_uuid | string | A universal ID of the visitor |
Visitor IDs
Endpoint: /public/v1/visitor_ids
Description: This provides access to a collection of visitor records, each identified by a numeric ID, containing information such as the visitor’s email address, domain, creation and update timestamps (in UTC), the MAP platform (Eloqua, Marketo, or Pardot) from which the ID was obtained, the unique contact identifier in the MAP platform, and a universal visitor UUID.
| Field Name | Type | Description |
|---|---|---|
| created_at_utc | timestamp | The timestamp (in UTC) of when the visitor record was created |
| string | The email address of the known visitor | |
| email_domain | string | The domain of the known visitor’s email address |
| id | integer | A numeric ID of the visitor |
| platform | string | The name of the MAP platform that the ID was obtained from – Eloqua, Marketo or Pardot |
| platform_contact_id | string | The unique identifier that the contact’s record has in the MAP platform |
| updated_at_utc | timestamp | The timestamp (in UTC) that the visitor record was last updated |
| visitor_uuid | string | A universal ID of the visitor |