Lark Files icon

Lark Files

Lark Files Management

Overview

This node, named "Lark Files," is designed to manage files within the Lark (Feishu) ecosystem. Specifically, the operation "Obtain Statistics Of A File" allows users to retrieve statistical information about a particular file stored in Lark Docs. This can be useful for monitoring file usage, access patterns, or gathering metadata for reporting purposes.

Practical scenarios include:

  • Tracking how often a document has been accessed or modified.
  • Gathering analytics on file engagement within a team or organization.
  • Integrating file statistics into dashboards or automated reports.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: Tenant Token, OAuth2
File Type Type of the document (e.g., doc, sheet). Used as a query parameter in the request.
File Token Unique token identifying the file whose statistics are to be obtained. Required property.
Options Additional optional settings:
• Use Custom Body — whether to send a custom request body.

Output

The node outputs JSON data containing the statistics of the specified file. The exact structure depends on the Lark Docs API response but typically includes metrics such as view counts, edit counts, and other usage details related to the file.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Lark (Feishu) Open API.
  • Needs either a Tenant Token or OAuth2 authentication credential configured in n8n.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions/scopes must be granted to the authentication method to access file statistics.

Troubleshooting

  • Missing or invalid File Token: Ensure the "File Token" property is correctly set; otherwise, the API will reject the request.
  • Authentication errors: Verify that the selected authentication method is properly configured and valid.
  • Incorrect File Type: If the file type does not match the actual file, the API might return errors or empty statistics.
  • API rate limits or network issues: These may cause request failures; check connectivity and API usage quotas.
  • Use Custom Body option: If enabled incorrectly, it might lead to malformed requests; use only if you know the required request body format.

Links and References

Discussion