iBill.io icon

iBill.io

Consume iBill.io API (v.0.1.4)
Join our community

Actions17

Overview

This node integrates with the iBill.io API to perform operations related to sessions, specifically listing active sessions for a given service. It is useful for scenarios where you need to retrieve session data filtered by service ID, with options to control sorting, pagination, and result limits. For example, it can be used to fetch active user sessions for a particular service in a CRM or billing system.

Use Case Examples

  1. Retrieve all active sessions for a specific service by providing the service ID.
  2. Fetch a limited number of active sessions ordered by start time in ascending or descending order.
  3. Paginate through active sessions using offset and limit parameters.

Properties

Name Meaning
Service ID The unique identifier of the service for which active sessions are to be listed. This is a required numeric input.
Query Parameters Optional parameters to customize the query, including order field, order direction, offset for pagination, and limit on the number of results returned.

Output

JSON

  • id - Unique identifier of the session.
  • serviceId - Identifier of the service associated with the session.
  • start - Start time of the session.
  • end - End time of the session, if applicable.
  • status - Current status of the session (e.g., active, completed).
  • userId - Identifier of the user associated with the session.

Dependencies

  • Requires an API key credential for iBill.io API authentication.

Troubleshooting

  • Common issues include invalid or missing service ID, resulting in errors or empty results.
  • Incorrect query parameters such as invalid order fields or out-of-range offset/limit values may cause API errors.
  • Network or authentication failures due to incorrect API credentials will prevent data retrieval.

Links

Discussion