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 website zones, pages, sites, and other entities. Specifically, for the Metrics API resource and the Get Zone Tap Recurrence operation, it fetches the average number of times an element (zone) was tapped during a screen view on an app.
This node is beneficial in scenarios where you want to analyze user engagement on specific interactive areas ("zones") of your mobile app or website. For example, marketers or UX analysts can use this metric to understand how frequently users tap on certain UI elements, helping optimize design and improve conversion rates.
Practical examples:
- Measuring tap recurrence on promotional banners within a mobile app.
- Analyzing user interaction frequency on call-to-action buttons.
- Comparing tap engagement across different device types or time periods.
Properties
| Name | Meaning |
|---|---|
| Zone ID | The unique identifier of the zone (UI element) for which the tap recurrence metric is requested. |
| Query Parameters | A collection of optional filters and parameters to refine the query: - Device: Filter by device type (All, Desktop, Mobile, Tablet). - End Date: End date of analysis range. - Format: Export format filter. - Frequency: Export frequency filter. - From: Export format filter. - Goal ID: Conversion goal ID for non-ecommerce goals. - IDs: Comma-separated list of segment IDs to filter. - Limit: Maximum number of results to return. - Metric Type: Quantile or Average. - Order: Ascending or Descending order. - 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 value used if metric type is Quantile. - Scope: Scope filter. - Segment IDs: Multiple segments separated by commas. - Start Date: Start date of analysis range. - State: Status filter. - To: End date of query date range. |
Output
The output JSON contains the response from the Contentsquare Metrics API endpoint for zone tap recurrence. This typically includes statistical data about the average number of taps per engaged session or screenview on the specified zone.
The exact structure depends on the API response but generally includes fields such as:
- The zone identifier.
- The calculated average or quantile tap recurrence metric.
- Metadata about the query period, device type, or segmentation applied.
If the API returns no content, the node outputs a status code indicating "204 No Content".
No binary data output is involved in this operation.
Dependencies
- Requires valid credentials with Client ID, Client Secret, and optionally Project ID and scope for the Contentsquare API.
- The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
- Network access to
https://api.contentsquare.comis required. - Proper configuration of the API credentials in n8n is necessary.
Troubleshooting
- Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure that the API credentials are correctly set up.
- Zone ID Required: If the Zone ID property is empty when calling this operation, the node throws an error indicating the requirement.
- Failed to Retrieve Access Token or Endpoint: Errors occur if the OAuth token request fails or the endpoint URL is missing. Verify credentials and network connectivity.
- API Request Errors: Any HTTP or API errors are caught and reported with the message "Error calling Contentsquare API" along with the original error message and stack trace.
- Invalid Query Parameters: Providing invalid or conflicting query parameters may result in API errors; verify parameter values and formats.
- Empty or Unexpected Response: If the API returns an empty string or unexpected format, the node attempts to parse it; otherwise, it returns a 204 status indication.