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 website zones, pages, sites, and other entities. Specifically, the "Get Zone Click Recurrence" operation fetches the average number of clicks on a specified zone for pageviews where the zone was selected at least once.

This node is beneficial in scenarios where you want to analyze user engagement with specific interactive areas (zones) on your website or app. For example, marketers or UX analysts can use it to understand how frequently users click on a particular button or link area, helping optimize design and conversion strategies.

Practical examples:

  • Measuring how often users click on a promotional banner zone.
  • Tracking repeated interactions with a call-to-action button zone.
  • Comparing click recurrence across different device types or time periods.

Properties

Name Meaning
Zone ID The unique identifier of the zone for which the click recurrence metric is requested. This is required to specify the target zone.
Query Parameters A collection of optional filters and parameters to refine the query results:
- Device: Filter by device type (All, Desktop, Mobile, Tablet).
- End Date: End date of analysis range.
- Format: Format of the query.
- Frequency: Export frequency filter.
- From: Export format filter.
- Goal ID: Conversion goal identifier.
- IDs: Comma-separated list of segment IDs.
- Limit: Maximum number of results (default 50).
- Metric Type: Quantile or Average.
- Order: Ascending or Descending.
- Page: Page number of results.
- Period: Granularity (Daily or None).
- Project ID: Target project ID (for account-level API keys).
- Quantile: Percentile value if metric type is quantile (default 75).
- Scope, Segment IDs, Start Date, State, To: Additional filtering options.

Output

The output is a JSON array containing the response data from the Contentsquare API for the requested metric. The structure depends on the API's response but generally includes statistical data about the average number of clicks on the specified zone during pageviews where the zone was selected.

If the API returns no content, the node outputs a status code message indicating "204 No Content".

The node does not output binary data.

Dependencies

  • Requires an API key credential with Client ID, Client Secret, Project ID, and Scope configured in n8n credentials.
  • Makes authenticated HTTP requests to the Contentsquare API endpoint.
  • Uses OAuth2 client credentials flow to obtain an access token before making metric requests.

Troubleshooting

  • Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure that the API credentials are correctly set up.
  • Failed to retrieve access token or endpoint: Indicates issues with authentication or API configuration; verify credentials and network connectivity.
  • Zone ID is required: For this operation, the Zone ID must be provided; otherwise, the node throws an error.
  • Invalid query parameters: Providing incorrect or incompatible query parameters may cause API errors; validate parameter values especially dates and numeric fields.
  • API rate limits or network errors: May cause request failures; consider retrying or checking API usage quotas.

Links and References

Discussion