Lark Sheets icon

Lark Sheets

Lark Sheets Management

Actions23

Overview

The node enables creating a Filter View on a specific sheet within a spreadsheet in Lark Sheets. A Filter View allows users to save and apply custom filter settings without altering the underlying data or other users' views. This is useful for scenarios where multiple users need to analyze or view data differently without interfering with each other's filters.

Practical examples:

  • Creating a saved filter to show only rows matching certain criteria, such as sales above a threshold.
  • Setting up different filter views for various departments to quickly switch between relevant data slices.
  • Automating the creation of filter views based on dynamic conditions or user input.

Properties

Name Meaning
Authentication Method of authentication to use: "Tenant Token" or "OAuth2".
Spreadsheet Token The unique token identifying the target spreadsheet.
Sheet Id The identifier of the specific sheet within the spreadsheet where the filter view will be created.
Filter View Id (Optional) Identifier for the new filter view.
Filter View Name (Optional) Name to assign to the new filter view.
Range (Optional) The cell range that the filter view applies to, e.g., "A1:D20".
Custom Body JSON object allowing full customization of the request body sent to create the filter view.
Options > Use Custom Body Boolean flag indicating whether to send the custom JSON body instead of individual parameters.

Output

The node outputs JSON data representing the response from the Lark Sheets API after creating the filter view. This typically includes details about the newly created filter view such as its ID, name, and range.

If binary data were involved (not indicated here), it would represent file content or similar, but this node focuses on JSON metadata output.

Dependencies

  • Requires an active connection to Lark Sheets via either a Tenant Token or OAuth2 authentication.
  • Needs proper configuration of credentials in n8n for authentication.
  • Relies on the Lark Sheets API endpoint at https://open.larksuite.com/open-apis.

Troubleshooting

  • Invalid or missing Spreadsheet Token or Sheet Id: Ensure these identifiers are correct and correspond to existing resources.
  • Authentication errors: Verify that the provided API key or OAuth2 token is valid and has sufficient permissions.
  • Incorrect range format: The range should follow standard spreadsheet notation (e.g., "A1:C10").
  • Using Custom Body option: If enabled, ensure the JSON structure matches the expected API schema; malformed JSON will cause request failures.
  • API rate limits or network issues: May cause intermittent failures; retry or check network connectivity.

Common error messages might include unauthorized access, resource not found, or bad request due to invalid parameters. Resolving them involves checking credentials, verifying IDs, and validating input formats.

Links and References

Discussion