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 and mobile apps. Specifically, the "Get Page Landing Rate" operation fetches the ratio of users who landed on a particular screen (page group) compared to the total number of users, which is useful for mobile projects.

Common scenarios where this node is beneficial include:

  • Analyzing how effectively specific pages or screens attract users in mobile applications.
  • Monitoring landing rates over time to assess the impact of marketing campaigns or UI changes.
  • Segmenting landing rate data by device type or other filters to understand audience behavior.

For example, a mobile app product manager might use this node to track the landing rate of the home screen after a new feature launch, filtering results by device type to optimize user experience.

Properties

Name Meaning
Page Group ID The unique identifier of the page group (screen) for which the landing rate metric is requested. This is required for the operation.
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: For conversion metrics of non-ecommerce goals.
- IDs: Comma-separated list of segment IDs to filter.
- Limit: Maximum number of results to return (default 50).
- Metric Type: Quantile or Average (default Quantile).
- Order: Ascending or Descending order (default Descending).
- Page: Page number of results.
- 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, Segment IDs, Start Date, State, To: Additional filters for the query.

Output

The output is a JSON array containing the response from the Contentsquare Metrics API for the page landing rate metric. The structure depends on the API response but generally includes:

  • Metrics data about the landing rate for the specified page group.
  • Possibly segmented or filtered according to the query parameters provided.
  • If no content is returned, a status code message like "204 No Content" is included.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for the Contentsquare API, 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.com is necessary.
  • Proper configuration of the API credentials in n8n is mandatory.

Troubleshooting

  • Missing Client ID or Client Secret: The node will throw an error if these credentials are not set. Ensure that valid credentials are configured.
  • Missing Page Group ID: This parameter is required for the "Get Page Landing Rate" operation. The node throws an error if it is not provided.
  • Failed to retrieve access token or endpoint: Indicates issues with authentication or API availability. Verify credentials and network connectivity.
  • 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.
  • Empty or unexpected responses: May indicate incorrect parameters or no data available for the given filters. Adjust query parameters accordingly.

Links and References

Discussion