Contentsquare icon

Contentsquare

Use the Contentsquare API

Actions76

Overview

This node integrates with the Contentsquare API to retrieve detailed user behavior and performance metrics related to web pages. Specifically, the "Get Page Conversion Rate" operation fetches the ratio of users who viewed a particular page and subsequently reached a defined goal during their navigation, compared to all users who viewed that page.

This node is beneficial for digital marketers, UX analysts, and product managers who want to measure how effectively specific pages convert visitors towards desired actions (e.g., purchases, sign-ups). For example, it can be used to analyze conversion rates for landing pages, helping optimize content or design to improve user engagement and conversions.

Properties

Name Meaning
Page Group ID The identifier of the page group for which the conversion rate metric is requested. This is required to specify the target page group.
Query Parameters A collection of optional filters and parameters to refine the query:
- Device: Filter by device type (All, Desktop, Mobile, Tablet).
- End Date: End date of the analysis range.
- Format: Format of the query date range.
- Frequency: Export frequency filter.
- From: Export format filter.
- Goal ID: Specify a non-ecommerce goal to return conversion metrics for.
- IDs: Comma-separated list of segment IDs to filter results.
- Limit: Maximum number of results to return (default 50).
- Metric Type: Choose between Quantile or Average metric types.
- 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 value used if metric type is Quantile (default 75).
- Scope: Scope filter.
- Segment IDs: Multiple segments separated by commas to get intersection metrics.
- Start Date: Start date of the analysis range.
- State: Status filter.
- To: End date of the query date range.

Output

The output is a JSON array containing the response data from the Contentsquare API for the requested page conversion rate metric. The structure depends on the API's response but generally includes:

  • Conversion rate values for the specified page group.
  • Breakdown by any applied filters such as device type or date range.
  • Additional metadata about the metric depending on the query parameters.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for the Contentsquare API with appropriate permissions.
  • The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
  • Network connectivity to https://api.contentsquare.com is necessary.
  • Proper configuration of the API credentials in n8n is required (Client ID, Client Secret, Project ID, and scope).

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.
  • Missing Page Group ID: This parameter is mandatory for the "Get Page Conversion Rate" operation. If omitted, the node throws an error.
  • Failed to retrieve access token or endpoint: Indicates issues with authentication or API availability. Verify credentials and network access.
  • API errors: Any error returned by the Contentsquare API will be wrapped and reported by the node. Check the error message and stack trace for details.
  • Invalid query parameters: Providing invalid or conflicting query parameters may cause API errors. Validate inputs carefully.

Links and References

Discussion