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 or app zones, pages, and site-wide data. Specifically, the "Get Zone Swipe Rate Recurrence" operation fetches the average number of times an element (zone) was swiped when engaged with during a screen view on an app.
This node is beneficial for digital analysts and marketers who want to understand user engagement patterns at a granular level, such as how frequently users interact with specific UI elements via swipes. For example, it can help identify highly interactive zones in a mobile app, informing UX improvements or targeted content placement.
Properties
| Name | Meaning |
|---|---|
| Zone ID | The unique identifier of the zone (UI element) for which the swipe rate recurrence 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: Format of the query date range. - Frequency: Export frequency filter. - From: Export format filter. - Goal ID: Conversion goal identifier. - IDs: Comma-separated list of segment IDs. - Limit: Max number of results (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 (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 metric. The structure depends on the API's response but generally includes statistical data about the swipe recurrence on the specified zone, such as average counts or quantiles over the selected time period and filters.
No binary data output is produced by this node.
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 that valid API credentials are configured.
- Zone ID is required: If the Zone ID property is empty when calling this operation, the node throws an error. Provide a valid Zone ID.
- Failed to retrieve access token or endpoint: Indicates issues with authentication or API configuration; verify credentials and network connectivity.
- API request errors: Any HTTP or API errors are wrapped and reported with messages starting with "Error calling Contentsquare API". Check the error message and stack trace for details.
- Invalid query parameters: Providing invalid or conflicting query parameters may cause API errors. Validate parameter values according to the API documentation.
Links and References
- Contentsquare API Documentation
- Contentsquare Metrics API Reference
- OAuth2 Client Credentials Flow: https://oauth.net/2/grant-types/client-credentials/