Audiobookshelf icon

Audiobookshelf

Work with the Audiobookshelf API

Overview

This node integrates with the Audiobookshelf API to retrieve data related to users, libraries, and library items. Specifically, for the "User" resource and the "Get User's Listening Sessions" operation, it fetches detailed information about the listening sessions of a specified user. This can be useful for tracking user engagement, analyzing listening habits, or generating reports on audiobook consumption.

Practical examples include:

  • Monitoring how many audiobooks a user has listened to over time.
  • Analyzing session durations to understand user behavior.
  • Integrating user listening data into dashboards or CRM systems.

Properties

Name Meaning
User ID The unique identifier of the user whose listening sessions you want to retrieve. This is a required string input.

Output

The node outputs JSON data containing the user's listening sessions. Each session typically includes details such as timestamps, duration, and possibly metadata about the audiobook listened to during that session.

If the node supports binary data output (not explicitly shown in the provided code), it would likely relate to media files or session-related attachments, but this is not indicated here.

Dependencies

  • Requires an API key credential for authenticating with the Audiobookshelf API.
  • The base URL for API requests is dynamically set from the provided credentials (domain).
  • No other external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Invalid or missing User ID will prevent retrieval of listening sessions.
    • Incorrect or expired API credentials will cause authentication failures.
    • Network issues or incorrect domain configuration may lead to request errors.
  • Error Messages:

    • Authentication errors typically indicate invalid API keys; verify and update credentials.
    • "User not found" or similar messages suggest the provided User ID does not exist.
    • Timeout or connection errors imply network problems or incorrect API endpoint setup.

Links and References

Discussion