Contentsquare

Overview

This node integrates with the Contentsquare API to retrieve detailed metrics and data related to user behavior on websites or apps. Specifically, the "List Page Groups" operation under the "Metrics API" resource fetches all page groups associated with a specific mapping ID. This is useful for analyzing grouped pages within a project to understand user interactions, segmentations, and performance metrics.

Common scenarios include:

• Retrieving all page groups for a given mapping to analyze grouped user behavior.
• Using page group data as a basis for further metric queries like activity rate, bounce rate, or conversion rate.
• Automating reporting workflows that require structured page group information from Contentsquare.

Example: A marketing analyst wants to get all page groups linked to a particular website mapping to prepare a report on user engagement segmented by page groups.

Properties

The "Query Parameters" collection supports these options:

• Device: Filter results by device type (All, Desktop, Mobile, Tablet).
• End Date: End of the date range for analysis.
• Format: Format filter for the query.
• Frequency: Filter based on export frequency.
• From: Filter based on export format.
• Goal ID: Return conversion metrics for a non-ecommerce goal.
• IDs: Filter segments by IDs (comma-separated).
• Limit: Maximum number of results to return (default 50).
• Metric Type: Choose between Quantile or Average metrics.
• Order: Sort order of results (Ascending or Descending).
• Page: Page number of results to retrieve.
• Period: Granularity of results (Daily or None).
• Project ID: Target project ID (required 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 metrics.
• Start Date: Start of the date range for analysis.
• State: Filter based on status.
• To: End date of the query date range.

Output

The output is a JSON array where each item represents a page group retrieved from the Contentsquare API for the specified mapping ID. The structure depends on the API response but typically includes details about each page group such as its ID, name, and possibly metadata related to the grouping.

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 an API key credential with Client ID, Client Secret, Project ID, and Scope configured in n8n credentials for Contentsquare.
• The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
• Network access to https://api.contentsquare.com is necessary.

Troubleshooting

• Missing Credentials: If Client ID or Client Secret are not provided, the node throws an error "Missing Client ID or Client Secret."
• Missing Required Parameters: For this operation, if the Mapping ID is not provided, the node throws "Mapping ID is required."
• Failed Token Retrieval: Errors like "Failed to retrieve access token" or "Failed to retrieve endpoint" indicate issues with authentication setup or network connectivity.
• API Errors: Any API call failure will throw an error prefixed with "Error calling Contentsquare API:" followed by the original message.
• Empty Responses: If the API returns empty or no content, the node outputs a "204 No Content" status object.

To resolve errors:

• Ensure all required credentials and parameters are set.
• Verify network connectivity to the Contentsquare API.
• Check that the API credentials have appropriate permissions.
• Confirm that the Mapping ID exists and is valid.

Links and References

• Contentsquare API Documentation
• OAuth 2.0 Client Credentials Flow
• n8n HTTP Request Helper