Contentsquare

Use the Contentsquare API

Actions76

Overview

This node integrates with the Contentsquare API to retrieve detailed user behavior and performance metrics for websites or applications. Specifically, the "Get Site Session Time Average" operation fetches the average duration visitors spend on a site from entry to exit during each session. This metric is useful for understanding user engagement and session quality.

Common scenarios where this node is beneficial include:

Analyzing how long users stay on a website to assess engagement.
Comparing session durations across different time periods or device types.
Monitoring the impact of changes in content or design on user session length.

For example, a digital marketing analyst might use this node to track if a recent redesign increased the average session time, indicating better user retention.

Properties

Name	Meaning
Query Parameters	Collection of optional filters and settings to customize the data retrieval:
- Device	Filter 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 non-ecommerce goal
- IDs	Comma-separated list of segment IDs to filter results
- Limit	Maximum number of results to return (minimum 1, default 50)
- Metric Type	Type of metric aggregation: Quantile or Average
- Order	Sort order of results: Ascending or Descending
- Page	Page number of results to retrieve
- Period	Granularity of results: Daily or None (only for date ranges larger than one day)
- Project ID	Target project identifier (required for account-level API keys)
- Quantile	Percentile used if Metric Type is Quantile (default 75, ignored if Metric Type is Average)
- Scope	Filter based on scope
- Segment IDs	Multiple segments separated by commas to get intersection 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

Output

The output JSON contains the response from the Contentsquare API endpoint /v1/metrics/site/session-time-average with the applied query parameters. It typically includes:

The average session time metric values over the requested period.
Additional metadata such as timestamps, device breakdowns, or segmentation details depending on the query parameters.

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

The node does not output binary data.

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 from https://api.contentsquare.com/v1/oauth/token.
The base API endpoint URL is dynamically retrieved from the authentication response.
Network access to Contentsquare API endpoints is required.

Troubleshooting

Missing Client ID or Client Secret: The node will throw an error if these credentials are not provided. Ensure your API key credential is correctly configured.
Failed to retrieve access token or endpoint: Indicates issues with authentication; verify credentials and network connectivity.
Required parameter missing errors: For this operation, ensure that any mandatory parameters (like projectId if using account-level API key) are set.
API request errors: The node wraps API errors with descriptive messages. Check the error message and stack trace for details.
Empty or unexpected responses: Confirm that query parameters like date ranges and filters are valid and that data exists for those criteria.