Contentsquare icon

Contentsquare

Use the Contentsquare API

Actions76

Overview

This node integrates with the Contentsquare API to retrieve detailed website metrics and user behavior data. Specifically, the "Get Site Bounce Rate" operation fetches the bounce rate for an entire site, which is the ratio of visitors who enter the site and leave without viewing a second page compared to all visitors.

This node is beneficial for digital analysts, marketers, and product managers who want to monitor user engagement and identify potential issues in user flow on their websites. For example, it can be used to track how changes in website design or content affect visitor retention by analyzing bounce rates over time.

Properties

Name Meaning
Device Filter results by device type: All, Desktop, Mobile, Tablet
End Date End date of the analysis range (must be after Start Date)
Format Format of the query date range
Frequency Filter based on export frequency
From Filter based on export format
Goal ID Return conversion metrics for a specific non-ecommerce goal
IDs Filter segments by comma-separated list of segment IDs
Limit Maximum number of results to return (minimum 1, default 50)
Metric Type Metric calculation type: Quantile (default) or Average
Order Sort order of results: Ascending or Descending (default Descending)
Page Page number of results to retrieve
Period Granularity of results: Daily or None (default None)
Project ID Target project identifier (required for account-level API keys)
Quantile Percentile value for quantile metric type (default 75, ignored if metric type is Average)
Scope Filter based on scope
Segment IDs Comma-separated list of segments to intersect for metrics
Start Date Start date of the analysis range (must be before End Date)
State Filter based on status
To End date of the query date range (similar to End Date)

Output

The output is a JSON array where each item contains the response from the Contentsquare Metrics API for the site bounce rate query. The structure depends on the API response but typically includes metrics such as bounce rate values, timestamps, and possibly breakdowns by filters like device or segments.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential with Client ID, Client Secret, and optionally Project ID and Scope.
  • The node performs OAuth2 client credentials flow to obtain an access token from Contentsquare.
  • Network access to https://api.contentsquare.com is required.
  • Proper configuration of credentials in n8n is necessary for authentication.

Troubleshooting

  • Missing Client ID or Client Secret: The node will throw an error if these are not provided in credentials.
  • Failed to retrieve access token or endpoint: Indicates authentication failure; verify credentials and network connectivity.
  • Required parameters missing: For this operation, no additional IDs are strictly required, but date ranges should be valid (startDate before endDate).
  • API errors: If the API returns errors, the node surfaces them with messages prefixed by "Error calling Contentsquare API".
  • Empty or malformed responses: Could indicate incorrect query parameters or API issues; check parameter validity and API status.

Links and References

Discussion