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, the "Get Zone Revenue per Click" operation fetches the average revenue generated per click on a specified zone element within a web page or app screen.
Use cases include:
- Measuring the effectiveness of interactive elements (zones) by understanding how much revenue each click generates.
- Optimizing UI/UX by identifying high-value zones that drive revenue.
- Segmenting revenue data by device type, date range, or other filters to analyze user behavior in detail.
Example: A marketing analyst can use this node to pull the average revenue per click for a promotional banner zone on their site during a specific campaign period, filtered by mobile users only.
Properties
| Name | Meaning |
|---|---|
| Zone ID | Numeric identifier of the zone (interactive element) for which the revenue per click metric is requested. This is required for the operation. |
| Query Parameters | Collection of optional filters and parameters to refine the query results: - Device: Filter by device type (All, Desktop, Mobile, Tablet). - Start Date / End Date: Define the date range for analysis. - Format, Frequency, From, To: Additional filtering options. - Goal ID: Specify a non-ecommerce goal for conversion metrics. - IDs, Segment IDs: Filter by segment identifiers. - Limit: Maximum number of results to return. - Metric Type: Quantile or Average. - Order: Ascending or Descending. - Page: Pagination control. - Period: Granularity of results (Daily or None). - Project ID: Target project identifier (required for account-level API keys). - Quantile: Percentile value used if metric type is quantile (default 75). - Scope, State: Additional filters based on scope or status. |
Output
The output is a JSON array containing the response from the Contentsquare API for the requested metric. The structure depends on the API's response but generally includes:
- Metrics data about average revenue per click for the specified zone.
- Possibly segmented or aggregated values according to the query parameters.
- Metadata such as pagination info if applicable.
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 in n8n credentials.
- Makes authenticated HTTP requests to the Contentsquare API endpoint.
- Uses OAuth2 client credentials flow to obtain an access token before making metric requests.
Troubleshooting
- Missing Credentials: If Client ID or Client Secret are missing, the node throws an error "Missing Client ID or Client Secret." Ensure these are set correctly in the credentials.
- Required Parameters Missing: For this operation, Zone ID must be provided; otherwise, an error "Zone ID is required" is thrown.
- Failed Token Retrieval: Errors like "Failed to retrieve access token" or "Failed to retrieve endpoint" indicate issues with authentication setup or API availability.
- API Errors: Any API call failure will throw an error prefixed with "Error calling Contentsquare API:" followed by the original message. Check network connectivity, API limits, and parameter correctness.
- Empty Responses: If the API returns empty or no content, the node outputs a "204 No Content" status, meaning no data matched the query filters.