Actions23
- Spreadsheet Actions
- Sheet Filter Actions
- Sheet Filter View Actions
- Filter Condition Filter View Actions
- Sheet Row Column Actions
- Sheet Data Actions
- Sheet Floating Image Actions
Overview
The "Create A Filter" operation in the "Sheet Filter" resource of the Lark Sheets node allows users to create a filter on a specific sheet within a spreadsheet. This filter can be used to display only rows that meet certain conditions, helping users to focus on relevant data subsets.
Common scenarios where this node is beneficial include:
- Automating data filtering in spreadsheets based on dynamic criteria.
- Integrating with workflows that require filtered views of large datasets.
- Creating custom reports or dashboards by filtering data programmatically.
For example, you might use this node to filter a sales report sheet to show only sales above a certain amount or to display entries from a specific region.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to access the Lark Sheets API. Options: Tenant Token, OAuth2. |
| Spreadsheet Token | The unique token identifying the target spreadsheet where the filter will be created. |
| Sheet Id | The identifier of the specific sheet within the spreadsheet to which the filter will be applied. |
| Col | The column on which the filter condition will be applied. |
| Condition | Defines the filter condition with the following sub-properties: - compare_type: The comparison operator (e.g., equals, greater than). - expected: One or more expected values for comparison. - filter_type: The type of filter to apply. |
| Range | The range of cells in the sheet to which the filter applies. |
| Custom Body | Allows sending a fully custom JSON body for the request instead of using the predefined properties. Useful for advanced or unsupported configurations. |
| Options > Use Custom Body | Boolean flag to indicate whether to use the Custom Body property instead of the standard input fields. |
Output
The node outputs JSON data representing the response from the Lark Sheets API after creating the filter. This typically includes confirmation details about the created filter such as its ID, status, and any metadata returned by the API.
If the node supports binary data output (not indicated here), it would represent file contents or attachments related to the operation, but this node primarily deals with JSON responses.
Dependencies
- Requires access to the Lark Sheets API.
- Requires authentication via either a Tenant Token or OAuth2 credentials configured in n8n.
- Network connectivity to
https://open.larksuite.com/open-apisis necessary.
Troubleshooting
- Authentication errors: Ensure that the provided API credentials are valid and have sufficient permissions to modify the target spreadsheet.
- Invalid Spreadsheet Token or Sheet Id: Verify that the tokens and IDs correspond to existing and accessible resources.
- Malformed Condition object: The filter condition must follow the expected structure; incorrect compare types or missing expected values may cause API errors.
- Using Custom Body: When enabling the custom body option, ensure the JSON is correctly formatted and matches the API specification to avoid request failures.
- API rate limits or network issues: May cause timeouts or errors; retry or check network connectivity.