AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions109

Overview

The "Get Websites" operation of the Websites resource retrieves a list of websites from an external service. This node is useful for scenarios where you need to fetch website data programmatically, such as integrating website information into workflows, monitoring website updates, or filtering websites based on specific criteria.

Practical examples include:

  • Fetching all websites with a certain name or URL slug.
  • Retrieving websites updated within a specific date range.
  • Paginating through large sets of website data by specifying page number and page size.
  • Searching websites by keywords.

Properties

Name Meaning
Additional Query Parameters Optional parameters to filter and paginate the results:
- Page: Get current page of results (number).
- Name: Filter websites by name (string).
- Page Size: Number of results per page (number).
- Slug: Filter by URL slug (string).
- Search: Filter by search query (string).
- Updated At: Filter websites updated within a range or at an exact time. Format: 'start_datetime,end_datetime' in ISO 8601 format. Examples:
'2023-06-07T12:34:56Z,' (from start datetime until now)
',2023-06-07T12:34:56Z' (until end datetime)
'2023-06-01T12:34:56Z,2023-06-07T12:34:56Z' (within range)

Output

The node outputs JSON data representing the list of websites retrieved according to the specified filters and pagination. The structure typically includes website details such as name, slug, update timestamps, and other metadata provided by the external API.

If binary data were supported, it would represent associated files or media related to the websites, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating requests to the external AvantGuard WebhookSite service.
  • The base URL for the API is configured via credentials.
  • Uses the @avantguardllc/n8n-openapi-node package internally to build request properties from an OpenAPI specification.

Troubleshooting

  • Empty Results: If no websites are returned, verify that your query parameters (e.g., name, slug, updated_at) are correct and match existing data.
  • Invalid Date Format: The updated_at parameter must be in ISO 8601 format; incorrect formatting may cause errors or no results.
  • Authentication Errors: Ensure the API key credential is valid and has proper permissions.
  • Pagination Issues: If you receive fewer results than expected, check the page and page_size parameters to correctly paginate through data.
  • Network or API Errors: Check connectivity and API status if requests fail unexpectedly.

Links and References

  • ISO 8601 Date Format
  • Documentation for the external AvantGuard WebhookSite API (not included here, refer to your API provider)

Discussion