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 exports. Specifically, for the Metrics API resource and the Get Zone Conversion Rate per Tap operation, it fetches the percentage of users who tapped on a specific zone in an app and completed a selected goal during the same session.
This node is beneficial for digital analysts and marketers who want to understand how interactive elements (zones) on their mobile apps contribute to conversion goals. For example, it can help measure the effectiveness of call-to-action buttons or promotional banners by tracking tap interactions that lead to conversions.
Practical use cases include:
- Measuring conversion rates for tappable zones in mobile applications.
- Analyzing user engagement and conversion funnels at a granular zone level.
- Optimizing UI/UX by identifying high-conversion zones.
Properties
| Name | Meaning |
|---|---|
| Zone ID | The unique identifier of the zone for which the conversion rate per tap metric is requested. This is required to specify the target zone. |
| Query Parameters | A collection of optional filters and parameters to refine the query results: - 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: Specify a non-ecommerce goal for conversion metrics. - IDs: Comma-separated list of segment IDs to filter. - Limit: Maximum number of results to return (default 50). - Metric Type: Quantile or Average. - 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, Segment IDs, Start Date, State, To: Additional filtering options. |
Output
The output is a JSON array where each item corresponds to the API response for the requested metric. The structure depends on the Contentsquare API's response for the "zone conversion rate per tap" metric but generally includes:
- Conversion rate values representing the percentage of users who tapped the zone and completed the specified goal.
- Possibly additional metadata such as timestamps, device breakdowns, or segmentation details depending on query parameters.
If the API returns no content, the node outputs a status code message indicating "204 No Content".
The node does not output binary data.
Dependencies
- Requires an API key credential with Client ID, Client Secret, Project ID, and scope configured 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 necessary.
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.
- Zone ID is required: For this operation, the Zone ID must be provided; otherwise, the node throws an error.
- Failed to retrieve access token or endpoint: Indicates issues with authentication or API availability. Verify credentials and network connectivity.
- API errors: If the API returns an error, the node wraps it with a message starting with "Error calling Contentsquare API". Check the error message and stack trace for details.
- Empty or malformed responses: The node attempts to parse string responses as JSON; if parsing fails, it returns raw text. Ensure the API returns valid JSON.
Links and References
- Contentsquare API Documentation
- Contentsquare Metrics API Reference
- OAuth2 Client Credentials Flow: https://oauth.net/2/grant-types/client-credentials/