Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the Connect Secure API to retrieve statistical data about companies. Specifically, the "Retrieve Company Stats" operation fetches company statistics based on user-defined query parameters such as filtering conditions, pagination controls, and sorting preferences.

Common scenarios for this node include:

  • Fetching summarized or detailed statistics about companies for reporting or analytics.
  • Integrating company stats into workflows that require up-to-date business metrics.
  • Automating data retrieval for dashboards or monitoring systems.

For example, a user might want to retrieve the top 10 companies ordered by revenue, skipping the first 5 records, or filter companies based on specific criteria using a condition string.

Properties

Name Meaning
X USER ID User Id required for authentication; sent as a header in the API request.
Condition Query condition string to filter which company stats are retrieved.
Skip Number of records to skip (pagination offset).
Limit Maximum number of records to return (pagination limit).
Order By Field(s) by which to order the returned company stats.

Output

The node outputs JSON data containing the retrieved company statistics matching the query parameters. The structure typically includes an array of company stat objects, each representing a company's statistical data as returned by the Connect Secure API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • Depends on the Connect Secure API being accessible and the provided user ID being valid.
  • The node uses the OpenAPI specification bundled internally to define its operations and properties.

Troubleshooting

  • Missing or invalid X USER ID: The API requires a valid user ID header; ensure it is provided and correct.
  • Invalid query condition syntax: If the condition string is malformed, the API may reject the request or return no results.
  • Pagination issues: Setting skip or limit incorrectly (e.g., negative numbers) may cause errors or unexpected results.
  • Order By field invalid: Specifying a non-existent field in order_by can lead to API errors or default ordering.
  • API connectivity problems: Network issues or incorrect API credentials will prevent successful data retrieval.

Error messages from the API should be reviewed to adjust input parameters accordingly.

Links and References

Discussion