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 including the Data Export API. The "List Successful Job Runs" operation under the Data Export API resource retrieves a list of all job runs that have completed successfully. This is useful for monitoring and auditing export jobs to ensure data exports are completed as expected.
Typical use cases include:
- Automating the retrieval of successful export job runs for reporting or further processing.
- Monitoring export job statuses in bulk without manually checking each job run.
- Integrating export job run data into workflows for downstream analytics or alerting.
For example, a marketing analyst could use this node to automatically fetch all successful data export runs from Contentsquare to update dashboards or trigger notifications when new data exports are available.
Properties
| Name | Meaning |
|---|---|
| Query Parameters | A collection of optional filters and parameters to refine the list of successful job runs. These include: - Device: Filter by device type (All, Desktop, Mobile, Tablet). - End Date: End date of the query range. - Format: Format filter. - Frequency: Filter by export frequency. - From: Filter by export format. - Goal ID: Return conversion metrics for a non-ecommerce goal. - 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 order. - Page: Page number of results. - Period: Granularity of results (Daily or None). - Project ID: Target project ID (required for account-level API key). - Quantile: Percentile value if metric type is quantile (default 75). - Scope: Scope filter. - Segment IDs: Multiple segments separated by commas. - Start Date: Start date of the query range. - State: Status filter. - To: End date of the query range. |
Output
The output is a JSON array where each item represents a successful job run retrieved from the Contentsquare API. The structure of each JSON object corresponds directly to the API response for successful job runs, typically including details such as job run identifiers, timestamps, status, and possibly metadata about the export.
If the API returns no content, the node outputs an object indicating "204 No Content".
No binary data output is involved in this operation.
Dependencies
- Requires valid Contentsquare API credentials including Client ID, Client Secret, and optionally Project ID and scope.
- The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
- Network access to
https://api.contentsquare.comis required. - Proper configuration of the API credentials within n8n is necessary.
Troubleshooting
- Missing Credentials: If Client ID or Client Secret is missing, the node throws an error "Missing Client ID or Client Secret." Ensure these are correctly configured.
- Access Token Retrieval Failure: Errors like "Failed to retrieve access token" or "Failed to retrieve endpoint" indicate issues with authentication or API availability.
- Required Parameter Missing: For some operations, required parameters like Job ID must be provided; otherwise, errors will be thrown.
- 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 and stack trace.
- Empty Response: If the API returns no data, the node outputs a "204 No Content" status object.
To resolve common issues:
- Verify API credentials and permissions.
- Confirm required parameters are set.
- Check network connectivity to the API endpoint.
- Review API limits or restrictions imposed by Contentsquare.