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 Height" operation under the "Metrics API" resource fetches the average height of a page in pixels at its first load, averaged across all URLs included in the specified page group.
This node is useful for digital analysts, UX researchers, and marketers who want to understand how users experience their web pages, particularly regarding layout and content length. For example, knowing the average page height can help optimize page design for better engagement or identify issues with content rendering on different devices.
Practical example: A website manager wants to monitor if recent changes to a landing page have affected its average height, which could impact user scrolling behavior and engagement. Using this node, they can programmatically fetch this metric and trigger alerts or reports.
Properties
| Name | Meaning |
|---|---|
| Page Group ID | The identifier of the page group for which the average page height is requested. This is required to specify the target set of pages. |
| Query Parameters | Optional filters and parameters to refine the data retrieval. These include: - Device: Filter by device type (All, Desktop, Mobile, Tablet). - End Date: End date of analysis range. - Format: Start date of query range. - Frequency: Export frequency filter. - From: Export format filter. - Goal ID: Conversion goal identifier. - IDs: Comma-separated segment IDs. - Limit: Maximum number of results (default 50). - Metric Type: Quantile or Average (default Quantile). - Order: Ascending or Descending (default Descending). - Page: Page number of results. - Period: Granularity of results (Daily or None). - Project ID: Target project ID (for account-level API keys). - Quantile: Percentile value if metric type is Quantile (default 75). - Scope, Segment IDs, Start Date, State, To: Additional filtering options. |
Output
The output is a JSON array where each item contains the response from the Contentsquare API for the requested page height metric. The structure depends on the API's response but generally includes:
- The average page height in pixels.
- Metadata about the page group and query parameters used.
- Possibly time series data if granularity is specified.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential with client ID, client secret, project ID, and scope configured in n8n credentials.
- The node authenticates via OAuth2 client credentials flow to obtain an access token.
- Makes HTTPS requests to the Contentsquare API endpoint.
- Requires network access to
https://api.contentsquare.com.
Troubleshooting
- Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure that the API key credential is correctly set up.
- Missing Page Group ID: This property is mandatory for the "Get Page Height" operation. If omitted, the node throws an error indicating it is required.
- Failed to retrieve access token or endpoint: Indicates authentication failure or misconfiguration of credentials.
- API request errors: Network issues, invalid parameters, or API limits may cause errors. The node surfaces these with descriptive messages including the API error message.
- Empty or unexpected responses: Check that the page group ID and query parameters are valid and that the API has data for the requested period.