Actions76
- Data Export API Actions
- Metrics API Actions
- Get Page Activity Rate
- Get Page Bounce Rate
- Get Page Conversion Rate
- Get Page Exit Rate
- Get Page Fold Height
- Get Page Height
- Get Page Interaction Time
- Get Page Landing Rate
- Get Page Scroll Rate
- Get Page Time Spent
- Get Page Unique Visits
- Get Page Views
- Get Page Views per Visit
- Get Page Visits
- Get Page Web Vitals
- Get Site Bounce Rate
- Get Site Cart Average
- Get Site Conversion Rate
- Get Site Conversions
- Get Site Pageview Average
- Get Site Revenue
- Get Site Session Time Average
- Get Site Visits
- Get Zone Attractiveness Rate
- Get Zone Click Rate
- Get Zone Click Recurrence
- Get Zone Conversion Rate per Click
- Get Zone Conversion Rate per Hover
- Get Zone Conversion Rate per Tap
- Get Zone Engagement Rate
- Get Zone Exposure Rate
- Get Zone Exposure Time
- Get Zone Hesitation Time
- Get Zone Hover Rate
- Get Zone Hover Time
- Get Zone Number of Clicks
- Get Zone Revenue
- Get Zone Revenue per Click
- Get Zone Revenue per Tap
- Get Zone Swipe Rate
- Get Zone Swipe Rate Recurrence
- Get Zone Tap Rate
- Get Zone Tap Recurrence
- Get Zone Time Before First Click
- Get Zone Time Before First Tap
- List Goals
- List Mappings
- List Page Groups
- List Page Groups Metrics
- List Segments
- List Site Metrics
- List Zone Metrics
- List Zones
- List Zonings
- Speed Analysis API Actions
Overview
This node integrates with the Contentsquare API to retrieve detailed user behavior and performance metrics related to web pages. Specifically, the "Get Page Scroll Rate" operation fetches the proportion of a page that visitors have scrolled through, expressed as the ratio between the last line of pixels displayed on the screen and the total height of the page.
This node is beneficial for digital analysts, marketers, and UX designers who want to understand how deeply users engage with their web content by measuring scroll depth. For example, it can help identify if important content placed lower on a page is being seen or if users drop off early.
Practical use cases include:
- Measuring scroll engagement on landing pages to optimize content placement.
- Comparing scroll rates across device types (desktop, mobile, tablet).
- Tracking changes in scroll behavior over time after design updates.
Properties
| Name | Meaning |
|---|---|
| Page Group ID | Numeric identifier of the page group to analyze. This is required to specify which page group's scroll rate metric to retrieve. |
| Query Parameters | A collection of optional filters and settings to refine the data query: - Device: Filter results by device type (All, Desktop, Mobile, Tablet). - End Date: End date of the analysis range. - Format: Format of the query date range. - Frequency: Export frequency filter. - From: Export format filter. - Goal ID: Conversion goal ID for non-ecommerce goals. - IDs: Comma-separated segment IDs to filter. - Limit: Maximum number of results to return (default 50). - Metric Type: Choose between Quantile or Average metric calculation. - Order: Sort order of results (Ascending or Descending). - Page: Pagination page number. - Period: Granularity of results (Daily or None). - Project ID: Target project ID (required for account-level API keys). - Quantile: Percentile used if metric type is Quantile (default 75). - Scope, Segment IDs, Start Date, State, To: Additional filtering parameters. |
Output
The output is a JSON array where each item contains the response data from the Contentsquare API for the requested page scroll rate metric. The structure depends on the API's response but typically includes:
- Metrics representing the scroll rate values, possibly broken down by time periods or segments depending on query parameters.
- Metadata about the query such as timestamps or pagination info if applicable.
No binary data is returned by this operation.
Dependencies
- Requires an API key credential with client ID, client secret, and optionally project ID and scope for authentication.
- The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
- Network access to
https://api.contentsquare.comis necessary. - Proper configuration of the API credentials in n8n is mandatory.
Troubleshooting
- Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure your API credentials are correctly set up.
- Failed to retrieve access token or endpoint: Indicates issues with authentication or API availability. Verify credentials and network connectivity.
- Required parameter missing errors: For this operation, "Page Group ID" must be provided; otherwise, the node throws an error.
- API request errors: If the API returns an error, the node surfaces it with details. Check the API documentation for error codes and ensure query parameters are valid.
- Empty or unexpected responses: Confirm that the specified page group exists and that the date ranges and filters are correct.