Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node interacts with the Keitaro API to perform operations on various resources, including filters. Specifically, for the 'Фильтр' (Filter) resource and the 'Получить' (Get) operation, it retrieves information about a specific filter by its ID. This is useful for users who want to fetch detailed data about a particular filter in their Keitaro setup. For example, a user can input the filter ID to get its configuration and details from Keitaro.

Use Case Examples

  1. Retrieve details of a specific filter by providing its ID to monitor or modify filter settings.
  2. Use the node to fetch filter information as part of an automated workflow to analyze or report on filter configurations.

Properties

Name Meaning
ID Фильтра The unique identifier of the filter to retrieve information for. This property is required for the 'get' operation on the filter resource.

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro.
    • method - The HTTP method used for the API request.
    • headers - Headers sent with the API request, with the API key masked for security.
  • resource - The resource type involved in the operation, e.g., 'filter'.
  • operation - The operation performed, e.g., 'get'.
  • data - The data returned from the Keitaro API for the requested filter.
  • success - Indicates if the operation was successful (true for successful operations).
  • error - Indicates if there was an error during the operation, present only if an error occurred.

Dependencies

  • Requires Keitaro API credentials including domain and API key for authentication.

Troubleshooting

  • Ensure the filter ID is provided and valid for 'get' operations; missing or invalid IDs will cause errors.
  • Verify that the Keitaro API credentials (domain and API key) are correctly set up in the node credentials.
  • Check that the API endpoint URL is correctly formed with the domain and resource path.
  • If the API returns an error status, review the error message for details such as invalid permissions or resource not found.
  • For 'getAll' operations on other resources, ensure required parameters like date ranges or limits are set to avoid errors.

Links

Discussion