If you want to analyze and visualize Website Tools’ analytics data within your own visualization tools, you can use our API to push data directly into your data lake. You can call the API using Swagger or Postman, both of which provide the same output.
Set up API with Swagger
- Request an API access token from PathFactory.
- Go to https://datalakeapi.pathfactory.com/v3/docs.
- At the top right of the screen, select Authorize.
- Paste your access token in the Value field of either APIKeyQuery or APIKeyHeader.
- Select Authorize.
Available Authorization menu
- Select Get.
Get link
- Complete the following fields:
- created_at_start: enter the starting date and time
- created_at_end: enter the ending date and time
- limit: enter the number of outputs you want to view with the max being 1,000
- offset: use this field to specify the number of records you want to skip, thus starting in the middle of the dataset. For example, if you want to pull records 500 to 1,500, enter an offset of 500. The offset lets you fetch data beyond the max limit of 1,000.
API specification fields
- Select Execute. Scroll down to see the response.
Fields
| Data Point | Explanation | Example | |
| page_view_id | Unique identifier generated by PathFactory for each page view | ||
| visitor_id | PathFactory visitor ID | ||
| sessionid | The unique session ID | ||
| session_index | The session sequence the visitor had with content tracked through a PathFactory script.
eg: first session will have an index of 1, second session will have an index of 2, etc. |
3 | |
| page_view_index | The number of unique pages that have been viewed in a session | 1 | |
| total_page_views | The total number of page views that have occurred in a session | 1 | |
| created_at_start | Record creation timestamp which can be used for delta processing. It is inclusive, meaning it will include all records up to and including those that were recorded at the specified date and time. Should only be for data processing, not for visualizations in tools like Tableau.
This field will appear as created_at in the response. |
2021-05-27T00:12:11.623000+00:00 | |
| created_at_end | Record end timestamp which can be used for delta processing. It is inclusive, meaning it will include all records up to and including those that were recorded at the specified date and time. Should only be for data processing, not for visualizations in tools like Tableau.
This field will appear as created_at in the response |
||
| start_time | The session engagement start time in the time zone that is set in your PathFactory instance | 2021-05-27T00:12:11.589000+00:00 | |
| end_time | The session engagement end time in the time zone that is set in your PathFactory instance | 2021-05-27T00:12:11.589000+00:00 | |
| engagement_time_in_s | The session engagement time in seconds | ||
| vertical_percentage_scrolled | How far towards the bottom the visitor scrolled from the top | 20 | |
| page_width | The width of the page in pixels | 360 | |
| page_height | The height of the page in pixels | 9924 | |
| page_title | The title of the page as it was set using the | tag | |
| page_URL | The URL of the page visited, including any parameters that were present at the time of the visit | ||
| page_urlpath | The partial page path that comes after the subdomain/root domain part of the page URL | /blog | |
| page_urlquery | All the query string parameters associated with the page’s URL | ||
| marketing_medium | The value associated with the utm_medium parameter | Paid-Social | |
| marketing_source | The value associated with the utm_source parameter | ||
| marketing_term | The value associated with the utm_term parameter | LetsTallk-LLPLinkedInPaid | |
| marketing_content | The value associated with the utm_content parameter | Nurturing | |
| marketing_campaign | The value associated with the utm_campaign parameter | Lets Talk | |
| page_referrer | The URL of the page the visitor was on prior to visiting a PathFactory-tracked page.
Browsers may or may not provide a value. As such, you may not see this field being consistently populated with a value. |
null | |
| referrer_medium | The category of referred traffic to your content, such as direct. | null | |
| referrer_source | The source of referred traffic to your content, such as Google. | null | |
| referrer_term | null | ||
| ip_address | The IP address of the visitor | 192.154.320.234 | |
| browser | The web browser the visitor used when engaging with the webpage | Mozilla/5.0 (Linux; Android 10; moto g (7)power) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.210 Mobile Safari/537.36 | |
| spider_or_robot | Whether the visit was initiated by a bot or a crawler | FALSE | |
| os | Operating system of the visitor’s device when engaging with the webpage | Windows | |
| device_type | The device type the visitor used when engaging with the webpage | ||
| ip_isp | The Internet Service Provider associated with the IP address of the visit | Comcast Cable Communications LLC | |
| sixsense_company_domain | The domain of the company as provided by 6sense | ||
| sixsense_company_name | The company name as provided by 6sense | ||
| sixsense_company_region | The state associated with the company as provided by 6sense | ||
| sixsense_company_country | The country where the company is located as provided by 6sense | United States | |
| sixsense_company_country_iso_code | The country ISO code as provided by 6sense | US | |
| sixsense_company_state | The state where the visitor’s company is located as provided by 6sense | Pennsylvania | |
| sixsense_company_city | The city where the visitor’s company is located as provided by 6sense | Lancaster | |
| sixsense_company_street_address | The address of the visitor’s company as provided by 6sense | ||
| sixsense_company_postal_code | The postal/zip code associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_phone | The phone number associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_industry | The industry associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_employee_range | The employee range associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_revenue_range | The revenue range associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_employee_count | The number of employees associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_annual_revenue | The estimated annual revenue associated with the visitor’s company as provided by 6sense | ||
| sixsense_company_title_level | Job title level of the visitor who engaged with content as provided by 6sense | ||
| sixsense_company_title_function | Job function of the visitor who engaged with content as provided by 6sense | ||
| sixsense_company_siccode | The Standard Industrial Classification (SIC) code for the visitor’s company as provided by 6sense | ||
| sixsense_company_sicdescription | The Standard Industrial Classification (SIC) description for the visitor’s company as provided by 6sense | ||
| sixsense_company_naicscode | The North American Industry Classification System (NAICS) code for the visitor’s company as provided by 6sense | ||
| sixsense_company_naicsdescription | The North American Industry Classification System (NAICS) description for the visitor’s company as provided by 6sense | ||
| sixsense_confidence | The confidence level of segments as provided by 6sense. | Low |