Surense icon

Surense

Interact with Surense API

Actions36

Activity → Search Activities

AI-generated

Overview

The node provides integration with the Surense API, allowing users to interact with various Surense resources such as activities, contacts, customers, employers, leads, meetings, documents, workflows, and reports. Specifically, for the Activity resource with the Search Activities operation, the node enables searching and filtering of activity logs based on multiple criteria like activity types, authors, date ranges, related entities (customer, employer, lead, meeting, workflow), pagination, and text search.

This node is beneficial in scenarios where users want to programmatically retrieve filtered activity data from Surense for reporting, auditing, or automation purposes. For example, a user could search for all email-type activities authored by specific users within a certain date range or fetch paginated activity logs related to a particular customer or workflow.

Properties

Name Meaning
Additional Parameters A collection of optional filters and settings to refine the search query:
- Activity Log Types Select one or more activity log types to filter by. Options: Activity, Email, Call.
- Author Names or IDs Filter activities by specific authors. Users can select from a list or specify author IDs using expressions.
- Customer ID Filter activities related to a specific customer by their UUID.
- Date End Specify an exclusive end date/time to filter activities up to this point.
- Date Start Specify an inclusive start date/time to filter activities from this point onward.
- Employer ID Filter activities related to a specific employer by their UUID.
- Lead ID Filter activities related to a specific lead by their UUID.
- Meeting ID Filter activities related to a specific meeting by their UUID.
- Page The page number for paginated results (0-based index).
- Page Size Number of items per page to return. Minimum 1, maximum 100.
- Text Search Search text within activities to find matching entries.
- Workflow ID Filter activities related to a specific workflow by their UUID.

Output

The node outputs an array of JSON objects representing the activities that match the search criteria. Each item in the output corresponds to an activity record retrieved from the Surense API. The structure typically includes fields describing the activity details such as type, author, timestamps, related entities, and content.

If the node supports binary data output (not explicitly shown in the provided code), it would represent any associated files or attachments related to activities, but this is not indicated here.

Dependencies

  • Requires an active connection to the Surense API via OAuth2 authentication.
  • The node depends on the Surense API service being available and accessible.
  • Pagination support is included, so large result sets can be handled efficiently.
  • The node uses internal helper methods to load options dynamically (e.g., authors/users).

Troubleshooting

  • Common Issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Providing invalid UUID formats for IDs (customer, employer, lead, etc.) may result in errors or empty results.
    • Requesting pages beyond the available range may return empty arrays.
    • Using unsupported or incorrect filter values might yield no results.

  • Error Messages:

    • Errors returned from the Surense API are caught and can be output as error messages if "Continue On Fail" is enabled.
    • Typical errors include authentication errors, validation errors for parameters, or network connectivity issues.

  • Resolutions:

    • Verify API credentials and refresh tokens if necessary.
    • Ensure all UUIDs are correctly formatted.
    • Adjust pagination parameters to valid ranges.
    • Use the dynamic option loaders to select valid authors and other entities.

Links and References

Discussion