Cogfy Tables icon

Cogfy Tables

Interact with Cogfy Tables API for collections, records, and fields management

Actions26

Overview

This node operation "List Chats" under the "Chats" resource interacts with an API to retrieve a paginated list of chat records from a specified collection. It is useful for scenarios where you need to fetch multiple chat entries, possibly filtered by specific fields or records, and handle large datasets by paging through results.

Practical examples include:

  • Displaying chat history in a dashboard with pagination controls.
  • Exporting chats from a particular collection for analysis.
  • Filtering chats related to a specific record or field within a collection.

Properties

Name Meaning
Collection Id The unique identifier of the collection from which to list chats.
Page Number The page number to retrieve, starting at 0. Defaults to 0 (first page).
Page Size The number of chat results per page. Defaults to 10.
Field Id Optional filter: the ID of a chat field to narrow down the listed chats.
Record Id Optional filter: the ID of a record to narrow down the listed chats.

Output

The output JSON contains an array of chat objects representing the chats retrieved from the specified collection. Each chat object corresponds to a single chat entry with its associated data fields as returned by the API.

If the API supports binary data for chats (e.g., attachments), the node would handle it accordingly, but based on the provided code and properties, the primary output is structured JSON data representing chat records.

Dependencies

  • Requires an API key credential for authenticating requests to the Cogfy Tables API.
  • Needs the base URL of the Cogfy Tables API configured in the node credentials.
  • Depends on the external Cogfy Tables API service to fetch chat data.

Troubleshooting

  • Missing or invalid Collection Id: The node requires a valid collection identifier; ensure this is correctly set.
  • API authentication errors: Verify that the API key credential is properly configured and has necessary permissions.
  • Pagination issues: If no results are returned, check if the page number and size parameters are within valid ranges.
  • Filtering errors: Incorrect Field Id or Record Id values may result in empty responses; confirm these IDs exist in the collection.

Common error messages might include HTTP 401 Unauthorized (authentication failure), 404 Not Found (invalid collection or filters), or 400 Bad Request (invalid query parameters). Resolving these typically involves verifying credentials, input parameters, and API endpoint availability.

Links and References

Discussion