Contentsquare icon

Contentsquare

Use the Contentsquare API

Actions76

Overview

The node integrates with the Contentsquare Speed Analysis API to retrieve and manage performance testing scenarios for web pages. Specifically, the "List Scenarios" operation fetches a list of speed analysis scenarios, which are predefined tests or benchmarks used to detect slowdowns, identify optimization opportunities, and compare website performance against competitors.

This node is beneficial in scenarios where users want to automate the monitoring and analysis of website speed and user experience metrics. For example, it can be used to regularly pull scenario data to track performance trends over time or to trigger alerts when certain thresholds are exceeded.

Properties

Name Meaning
Query Parameters A collection of optional filters and parameters to refine the list of scenarios returned.

The Query Parameters collection supports the following options (among others):

  • Device: Filter scenarios by device type. Options: All, Desktop, Mobile, Tablet.

  • End Date: End date for 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 non-ecommerce goal.

  • IDs: Comma-separated list of segment IDs to filter results.

  • Limit: Maximum number of results to return (default 50).

  • Metric Type: Metric calculation method. Options: Quantile, Average.

  • Order: Sort order of results. Options: Ascending, Descending.

  • Page: Page number of results to retrieve.

  • Period: Granularity of results. Options: Daily, None.

  • Project ID: Target project identifier (required for account-level API keys).

  • Quantile: Percentile value used 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 (must be before end date).

  • State: Filter based on status.

  • To: End date of the query date range.

  • Request Body: JSON object for additional request payload if needed (not typically used for listing scenarios).

Output

The output is a JSON array where each element corresponds to an individual scenario retrieved from the API. The structure of each scenario object depends on the API response but generally includes details such as scenario identifiers, names, timestamps, and performance metrics.

If the API returns no content, the node outputs a status code 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 for authentication.
  • The node performs OAuth2 client credentials flow to obtain an access token before making API requests.
  • The base API endpoint URL is dynamically obtained from the authentication response.
  • Network connectivity to the Contentsquare API service is required.

Troubleshooting

  • Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure that valid API credentials are configured.
  • Failed to retrieve access token or endpoint: Indicates issues with authentication; verify credentials and network access.
  • Required parameters missing: Some operations require specific IDs (e.g., jobId, pageGroupId). For "List Scenarios", ensure query parameters are correctly formatted if used.
  • API errors: Errors returned from the API are wrapped and presented with descriptive messages. Check the API documentation for error codes and meanings.
  • Empty responses: If no scenarios match the query, the node returns a "204 No Content" status message.

Links and References

Discussion