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, specifically enabling access to the Speed Analysis API's "Get Scenario Report" operation. It allows users to retrieve detailed performance reports for specific scenarios analyzed by Contentsquare’s speed analysis tools. This is useful for monitoring web page load times, identifying slowdowns, and benchmarking against competitors.
Typical use cases include:
- Fetching scenario performance reports to analyze user experience on different devices.
- Automating performance monitoring workflows by retrieving scenario reports regularly.
- Integrating scenario report data into dashboards or other analytics platforms.
For example, a user can configure this node to request a scenario report filtered by device type (e.g., mobile), date range, and other parameters to understand how their website performs under various conditions.
Properties
| Name | Meaning |
|---|---|
| Query Parameters | Collection of optional filters and settings to customize the scenario report request: |
| - Device | Filter by device type: All, Desktop, Mobile, Tablet |
| - End Date | End of the date range for analysis (must be after Start Date) |
| - Format | Format of the query date range (string) |
| - Frequency | Filter based on export frequency |
| - From | Filter based on export format |
| - Goal ID | Return conversion metrics for a non-ecommerce goal (number) |
| - IDs | Comma-separated list of segment IDs to filter results |
| - Limit | Maximum number of results to return (default 50) |
| - Metric Type | Metric aggregation type: Quantile or Average |
| - Order | Sort order of results: Ascending or Descending |
| - Page | Page number of results to retrieve |
| - Period | Granularity of results: Daily or None (only for date ranges larger than one day) |
| - Project ID | Target project ID (required only 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 filtering |
| - Start Date | Beginning of date range for analysis (must be before End Date) |
| - State | Filter based on status |
| - To | End date of the query date range |
| Request Body | JSON object for additional request body data (optional, depending on operation) |
Output
The node outputs the JSON response from the Contentsquare Speed Analysis API scenario report endpoint. The structure depends on the API response but typically includes detailed metrics and performance data about the requested scenario(s).
If the API returns binary data (not typical for this operation), it would represent raw report files or HAR files related to the scenario analysis.
Dependencies
- Requires an API authentication token obtained via OAuth2 client credentials flow using a Client ID and Client Secret.
- Needs a valid Contentsquare API endpoint URL returned during authentication.
- Requires configuration of an API key credential in n8n with appropriate permissions for the Speed Analysis API.
- 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 configured.
- Failed to retrieve access token or endpoint: Indicates issues with authentication; verify that the client credentials and scopes are correct.
- Required parameter missing errors: For example, "Job ID is required" or "Page Group ID is required" errors occur if mandatory parameters for certain operations are not set.
- API call failures: Errors returned from the API will be wrapped and shown as "Error calling Contentsquare API". Check the message and stack trace for details.
- Empty or malformed responses: If the API returns empty or invalid JSON, the node attempts to handle it gracefully but may output a "204 No Content" status.