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. PathFactory leverages Demandbase as its official OEM data solution to provide robust audience insights. While 6sense data fields may still be available for legacy purposes, Demandbase is now the primary and actively supported integration.
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.
- API v1: Supports data from PathFactory Tracks, Explore, and Virtual Event Experiences (VEX), which use the Version 1 Data Model.
- API v3: Supports data from PathFactory Microsites, Themes & Templates, and Website Experiences, which use the Version 3 Data Model.
API V3 Field Definitions
API v3 introduces several new fields and enhancements designed to improve developer experience and provide powerful integration capabilities. These enhancements include:
- OAuth 2.0 Authentication and Role-Based API Keys: Improved authorization and access control for enhanced security.
- Demandbase Integration: Comprehensive audience insights powered by Demandbase, PathFactory’s official OEM data provider.
- Standardized JSON Responses with Metadata: Includes pagination details and other useful metadata for easier data processing.
- Rate Limiting and Quotas: Ensures fair usage and prevents abuse.
- Webhooks: Real-time updates and notifications for better efficiency.
For more details, see Setting Up Webhooks.
API V3 Endpoints and Descriptions
Content Assets
Endpoint: /public/v3/content_assets
Description: Provides functionalities for managing individual content assets, such as videos, PDFs, images, and interactive elements. Allows you to create, retrieve, update, and delete content assets, enabling dynamic content experiences.
| 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 | User-defined description of the content asset. |
external_id |
string | User-defined external ID for the content asset. |
internal_title |
string | Title of the asset as it appears in the library. |
language |
string | Language of the content asset. |
media_type |
string | The file type of the asset. |
slug |
string | URL slug of the asset. |
source_url |
string | Full source URL of the content asset. |
thumbnail |
string | Source URL of the asset thumbnail. |
title |
string | Title of the asset as it appears to visitors. |
updated_at_utc |
timestamp | Timestamp of when the asset was last modified/updated. |
uuid |
string | Universal ID of the content asset. |
Page Views
Endpoint: /public/v3/pageviews
Description: Captures data when a visitor views an asset inside a PathFactory Experience. Provides Demandbase data fields for enriched insights.
| Field Name | Type | Description |
page_view_id |
string | Unique ID for the page view. |
visitor_id |
integer | Numeric ID of the visitor. |
visitor_uuid |
string | Universal ID of the visitor. |
session_id |
string | PathFactory session ID. |
content_uuid |
string | Universal ID of the content asset. |
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 annual revenue size of the company/account from Demandbase. |
demandbase_employee_count |
integer | Identified number of employees in the company/account from Demandbase. |
demandbase_industry |
string | Identified industry type of the company/account from Demandbase. |
demandbase_web_site |
string | Identified company/account website URL from Demandbase. |
sixsense_company_name |
string | [Legacy] Identified company/account name from 6sense. |
sixsense_company_region |
string | [Legacy] Identified company/account region (geolocation) from 6sense. |
Note: For accurate and up-to-date data, use Demandbase fields as 6sense fields are maintained for legacy compatibility.
Visitor Activities
Endpoint: /public/v3/visitor_activities
Description: Tracks visitor activities within PathFactory Experiences, allowing you to personalize content and engage visitors more effectively. Includes Demandbase’s enriched insights for enhanced audience understanding.
| Field Name | Type | Description |
activity_name |
string | Name of the activity. |
activity_time |
timestamp | Timestamp when the activity occurred. |
activity_type |
string | Type of activity (e.g., Engagement_Score). |
demandbase_company_name |
string | Identified company/account name from Demandbase. |
sixsense_company_name |
string | [Legacy] Identified company/account name from 6sense. |
By leveraging Demandbase as PathFactory’s OEM data provider, the platform ensures consistent, reliable, and actionable insights for all supported features.
Views: 185