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 Activity Rate" operation fetches the ratio of time visitors spend interacting with a page compared to the total time spent on that page. This metric helps understand user engagement levels on specific pages.
Common scenarios where this node is beneficial include:
- Analyzing how engaging a particular page group is by measuring visitor interaction time.
- Comparing activity rates across different device types or date ranges.
- Monitoring changes in user engagement after website updates or redesigns.
For example, a digital marketing analyst might use this node to track if a landing page redesign has increased visitor interaction time, indicating better engagement.
Properties
| Name | Meaning |
|---|---|
| Page Group ID | The identifier of the page group for which the activity rate metric is requested. This is required to specify the target page group. |
| Query Parameters | A collection of optional filters and settings to refine the data retrieval: - 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: Filter based on export frequency. - From: Filter based on export format. - Goal ID: For conversion metrics of non-ecommerce goals. - IDs: Comma-separated list of segment IDs to filter. - Limit: Maximum number of results to return (default 50). - Metric Type: Choose between Quantile or Average. - Order: Sort order Ascending or Descending. - Page: Page number of results. - 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: Filter based on scope. - Segment IDs: Multiple segments separated by commas for intersection metrics. - Start Date: Start date of analysis range. - State: Filter based on status. - To: End date of query date range. |
Output
The output is a JSON array containing the response from the Contentsquare Metrics API for the page activity rate. The structure depends on the API's response but generally includes metrics about visitor interaction times relative to total page time for the specified page group and filters.
If the API returns no content, the node outputs an object indicating "204 No Content".
No binary data output is involved in 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 required.
Troubleshooting
- Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure the API credentials are correctly set up.
- Missing Required Parameters: For this operation, the "Page Group ID" must be provided; otherwise, an error is thrown.
- Failed to Retrieve Access Token or Endpoint: Indicates issues with authentication or API availability.
- API Errors: Any HTTP or API errors are caught and reported with messages prefixed by "Error calling Contentsquare API".
- Empty or Unexpected Responses: If the API returns empty or malformed data, the node attempts to parse it; if parsing fails, raw text is returned.
To resolve common errors:
- Verify API credentials and permissions.
- Confirm required parameters are set.
- Check network connectivity to the API endpoint.
- Review API limits or restrictions imposed by Contentsquare.