Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node interacts with the Keitaro API to perform operations on various resources, including the 'Группа' (Group) resource. Specifically, for the 'Получить' (Get) operation on the 'Группа' resource, it retrieves information about a specific group by its ID. This is useful for workflows that need to fetch detailed data about a particular group within the Keitaro system, such as for reporting, analysis, or further processing.

Use Case Examples

  1. Retrieve detailed information about a specific group by providing its ID to integrate group data into a marketing dashboard.
  2. Fetch group details to validate or update related campaign settings based on group attributes.

Properties

Name Meaning
ID Группы The unique identifier of the group to retrieve information for. This property is required for the 'get', 'update', and 'delete' operations on the 'group' 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., 'group'.
  • operation - The operation performed, e.g., 'get'.
  • data - The data returned from the Keitaro API for the requested group.
  • success - Indicates if the operation was successful (present for operations other than 'get' and 'getAll').
  • count - The count of items returned (present for 'getAll' operations).
  • error - Error details if the operation failed, including message, stack, resource, operation, URL, status, statusText, and response data.

Dependencies

  • Keitaro API key credential
  • Keitaro domain credential

Troubleshooting

  • Ensure the 'ID Группы' (group ID) is provided and valid for 'get' operations; missing or invalid IDs will cause errors.
  • Verify that the Keitaro API key and domain are correctly configured in the node credentials; missing credentials will prevent API access.
  • Check API response status codes and messages for clues on failures, such as permission issues or resource not found.
  • For 'getAll' operations, ensure that required parameters like pagination or filters are set correctly to avoid empty or excessive data responses.

Links

  • Keitaro API Documentation - Official documentation for the Keitaro API, useful for understanding available endpoints and data structures.

Discussion