Contentsquare icon

Contentsquare

Use the Contentsquare API

Actions76

Overview

This node integrates with the Contentsquare API to retrieve detailed user behavior and performance metrics. Specifically, the "List Goals" operation under the "Metrics API" resource fetches all goals defined for a project. This is useful for analytics workflows where you want to analyze or report on conversion goals tracked in Contentsquare.

Typical use cases include:

  • Retrieving all conversion goals to dynamically populate options in dashboards or reports.
  • Automating goal data extraction for further processing or integration with other marketing tools.
  • Monitoring and auditing goals configured in Contentsquare projects.

Properties

Name Meaning
Query Parameters A collection of optional filters and parameters to refine the goals list request. These include:
- Device: Filter by device type (All, Desktop, Mobile, Tablet)
- End Date: End date for analysis range
- Format: Start date of query range
- Frequency: Export frequency filter
- From: Export format filter
- Goal ID: Return conversion metrics for a specific non-ecommerce goal
- IDs: Comma-separated list of segment IDs to filter results
- Limit: Maximum number of results to return (default 50)
- Metric Type: Quantile or Average metric type
- Order: Ascending or Descending order of results
- 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 if metric type is quantile (default 75)
- Scope: Filter based on scope
- Segment IDs: Multiple segments separated by commas for intersection filtering
- Start Date: Start date for analysis range
- State: Filter based on status
- To: End date of query range

Output

The output is a JSON array where each item represents a goal object retrieved from the Contentsquare Metrics API. The structure corresponds directly to the API response for goals, typically including fields such as goal identifiers, names, types, and related metadata.

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

No binary data output is involved in 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 before making API requests.
  • Network access to https://api.contentsquare.com is required.
  • Proper configuration of the API credentials in n8n is necessary.

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 set up.
  • Failed to retrieve access token or endpoint: Indicates issues with authentication or API availability. Verify credentials and network connectivity.
  • Required parameter missing errors: For example, if a required parameter like "Page Group ID" or "Zone ID" is missing for certain operations, the node throws an error. Make sure to provide all mandatory inputs.
  • API call errors: Any HTTP or API errors are wrapped and reported with messages starting with "Error calling Contentsquare API". Check the error details for troubleshooting.
  • Empty or unexpected responses: If the API returns empty or malformed data, verify the query parameters and API status.

Links and References

Discussion