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 supporting multiple resources and operations including the Data Export API. For the Data Export API resource, the List Dynamic Variables operation retrieves all dynamic variables available on a project within a specified date range.
This operation is useful for users who want to analyze or export dynamic variable data tracked by Contentsquare, such as user interactions or custom metrics that change over time. It helps in extracting detailed behavioral data for further analysis or reporting.
Practical example:
A marketing analyst wants to pull all dynamic variables related to user sessions between two dates to understand how different variables evolve over time and influence conversion rates. They can use this node operation to fetch those variables filtered by device type, date range, and other parameters.
Properties
| Name | Meaning |
|---|---|
| Query Parameters | A collection of optional filters and settings to customize the query for dynamic variables. The available options include: |
| - Device | Filter results by device type. Options: All, Desktop, Mobile, Tablet. |
| - End Date | End of the date range for analysis (must be after Start Date). |
| - Format | Format filter for the query date range (string). |
| - Frequency | Filter based on export frequency (string). |
| - From | Filter based on export format (string). |
| - Goal ID | Return conversion metrics for a non-ecommerce goal (number). |
| - IDs | Filter segments matching provided IDs (comma-separated string). |
| - Limit | Maximum number of results to return (number, minimum 1, default 50). |
| - Metric Type | Metric calculation type. Options: Quantile, Average. Default is Quantile. |
| - Order | Order of results list. Options: Ascending, Descending. Default is Descending. |
| - Page | Page number of results to retrieve (number). |
| - Period | Granularity of results; can only be used if date range is larger than one day. Options: Daily, None. Default is None. |
| - Project ID | Target project ID (required only for account-level API key) (number). |
| - Quantile | Percentile for metric type quantile (ignored if metric type is average). Default is 75 (number). |
| - Scope | Filter based on scope (string). |
| - Segment IDs | Multiple segment IDs separated by commas to get intersection metrics (number). |
| - Start Date | Beginning of date range for analysis (must be before End Date) (string). |
| - State | Filter based on status (string). |
| - To | End date of the query date range (string). |
Output
The output is a JSON array where each item corresponds to an element returned by the Contentsquare API for the dynamic variables list. The structure depends on the API response but typically includes details about each dynamic variable such as its key, associated metadata, and possibly values or metrics within the specified date range.
If the API returns no content, the node outputs a status message indicating "204 No Content".
No binary data output is involved in this operation.
Dependencies
- Requires an active Contentsquare API credential with:
- Client ID
- Client Secret
- Optional Project ID and Scope depending on the API key level
- The node performs OAuth2 client credentials flow to obtain an access token.
- Network access to
https://api.contentsquare.comis required.
Troubleshooting
- Missing Credentials: If Client ID or Client Secret are not provided, the node throws an error "Missing Client ID or Client Secret."
- Access Token Retrieval Failure: If the OAuth token cannot be obtained, errors like "Failed to retrieve access token" or "Failed to retrieve endpoint" occur.
- Required Parameter Missing: For this operation, ensure that any required parameters (like date ranges) are correctly set; otherwise, the API may return errors or empty results.
- API Errors: Any HTTP or API errors are caught and rethrown with a message prefixed by "Error calling Contentsquare API:" along with the original error message.
- Invalid Query Parameters: Providing invalid or incorrectly formatted query parameters may cause the API to reject the request.
Links and References
- Contentsquare API Documentation (general reference for API endpoints and parameters)
- OAuth2 Client Credentials Flow (standard OAuth2 mechanism used by the node)
This summary focuses exclusively on the Data Export API resource and the List Dynamic Variables operation as requested.