Actions11
Overview
This node interacts with the Pulse API to manage recruitment-related data, specifically focusing on Candidates and their Quizz Sessions. For the Candidates Quizz Sessions resource, the List Quizz Sessions operation retrieves a paginated list of quiz sessions associated with candidates.
Typical use cases include:
- Fetching all quiz sessions for candidates to monitor progress or results.
- Filtering quiz sessions by specific criteria such as date or status.
- Sorting and paginating quiz session data for display in dashboards or reports.
For example, a recruiter might use this node to get all quiz sessions completed in the last month, sorted by creation date, to analyze candidate performance trends.
Properties
Name | Meaning |
---|---|
Include | Resources to include in the response. Currently supports including related "Quizzes" data within the quiz sessions. |
Additional Fields | A collection of optional parameters to customize the query: - Sort: Field name to sort by (e.g., "created_at" for ascending or "-created_at" for descending).- Page Number: The page number for pagination. - Page Size: Number of items per page. - Filters: One or more filters to narrow down results by specifying key-value pairs. - Fields: Specify which fields to include in the response for particular resource types by providing comma-separated lists. |
Output
The output is an array of JSON objects representing quiz sessions matching the query parameters. Each object contains details about a quiz session, potentially including nested quiz information if requested via the "Include" property.
If binary data were involved (not indicated here), it would typically represent files or media related to quiz sessions, but this node focuses on JSON data only.
Dependencies
- Requires connection to the Pulse API using an API authentication token configured in n8n credentials.
- The node depends on the Pulse API helper utilities bundled in the node's codebase to perform API requests.
- No additional external services are required beyond the Pulse API.
Troubleshooting
Common Issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing invalid filter keys or values may result in empty responses or errors from the API.
- Requesting pages beyond the available range will return empty results.
Error Messages:
"The operation "getQuizzSessionsList" is not supported for resource "quizzSessions"!"
— This indicates a mismatch between selected resource and operation; ensure correct selections.- API errors returned from Pulse (e.g., rate limits, invalid parameters) will be surfaced in the node output if "Continue On Fail" is enabled.
Resolutions:
- Verify API credentials and permissions.
- Double-check filter keys and values against Pulse API documentation.
- Adjust pagination parameters to valid ranges.
Links and References
- Pulse API Documentation (Replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- General info on Pagination and Filtering Best Practices