Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node integrates with the Keitaro API to manage filters and other resources. Specifically, for the 'Фильтр' (Filter) resource with the 'Создать' (Create) operation, it allows users to create a new filter by sending filter data in JSON format to the Keitaro API. This is useful for automating the creation of filters in Keitaro campaigns, streams, or other entities, enabling dynamic and programmatic management of filtering rules.

Use Case Examples

  1. Automatically create a new filter in Keitaro when a new campaign is set up.
  2. Use the node to add filters based on external data sources or user inputs, streamlining campaign management.

Properties

Name Meaning
Данные Фильтра The filter data in JSON format to be sent to the Keitaro API for creating or updating a filter.

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro, with sensitive API key masked.
    • method - The HTTP method used for the API request (e.g., POST for create).
  • resource - The resource type involved in the operation, here 'filter'.
  • operation - The operation performed, here 'create'.
  • success - Indicates if the operation was successful (true for create).
  • data - The data returned from the Keitaro API after creating the filter, typically the created filter details.

Dependencies

  • Requires an API key credential for Keitaro API access, including domain and API key.

Troubleshooting

  • Ensure the API key and domain are correctly set in the credentials; missing or incorrect values will cause authentication errors.
  • The filter data must be valid JSON and not empty; otherwise, the node will throw an error indicating missing data for the operation.
  • For the 'stats' resource, only the 'getAll' operation is supported; using other operations will result in an error.
  • If the API response status code is not in the 200-299 range, an error with the status code and message will be thrown.

Discussion