Kadam icon

Kadam

Interact with Kadam API (v1.4.x) for managing campaigns, clients, creatives, and more.

Actions24

Stats → Get Campaign Stats

AI-generated

Overview

The "Get Campaign Stats" operation of the Kadam node retrieves performance statistics for specified advertising campaigns over a defined date range. It allows grouping the data by date or campaign and supports sorting, pagination, and selective output fields. This operation is useful for marketers and analysts who want to monitor campaign effectiveness, track key metrics like impressions and clicks, and generate reports to optimize advertising strategies.

Practical examples:

  • Fetching daily performance stats for multiple campaigns over the past week to analyze trends.
  • Grouping stats by campaign to compare overall campaign performance.
  • Sorting results by views ascending and clicks descending to identify high-engagement campaigns.
  • Retrieving only specific fields such as cost, impressions, and click-through rate (CTR) for concise reporting.

Properties

Name Meaning
Campaigns List of campaign IDs to retrieve stats for. Use "Get Campaigns" operation to obtain valid IDs.
Group By How to group the statistics data. Options: Date (group by date), Campaign (group by campaign).
Date From Start date for statistics retrieval. Defaults to 7 days ago.
Date To End date for statistics retrieval. Defaults to today.
Sort Sort parameters as a comma-separated string, e.g., "views,-clicks". Prefix with - for descending order.
Retry on Failure Boolean flag to retry the request up to 3 times on temporary failures such as rate limits or network issues.
Return All Boolean flag to return all results by automatically paginating through data, ignoring limit and offset.
Limit Maximum number of items to return per request if Return All is false.
Offset Number of items to skip before starting to return results if Return All is false.
Output Fields Optional comma-separated list of fields to include in the output. Supports dot notation for nested fields (e.g., stats.impressions). If empty, all fields are returned.

Output

The output is an array of JSON objects representing campaign statistics grouped according to the selected "Group By" option. Each object contains various statistical fields such as impressions, clicks, cost, CTR, and other relevant metrics depending on the API response and requested output fields.

  • The structure can vary based on grouping but typically includes identifiers (campaign ID or date) and associated aggregated stats.
  • If binary data were involved (not applicable here), it would be summarized accordingly, but this operation returns only JSON data.

Dependencies

  • Requires an active connection to the Kadam API using an API token credential.
  • The node depends on proper configuration of the Kadam API credentials within n8n.
  • Network connectivity to https://api.kadam.net is required.
  • No additional external services beyond Kadam API are needed.

Troubleshooting

  • Common Issues:

    • Invalid or expired API token causing authentication failures.
    • Specifying campaign IDs that do not exist or belong to another client.
    • Date range errors such as dateFrom after dateTo.
    • Rate limiting by the Kadam API leading to temporary request failures.

  • Error Messages:

    • API errors will often include descriptive messages from Kadam's API, e.g., "API Error: [description]".
    • Network or timeout errors may occur; enabling "Retry on Failure" can mitigate transient issues.
    • If the node throws an error about unsupported resource or operation, verify that "Resource" is set to "Stats" and "Operation" to "Get Campaign Stats".

  • Resolution Tips:

    • Ensure API credentials are valid and have sufficient permissions.
    • Use the "Get Campaigns" operation to confirm valid campaign IDs.
    • Adjust date ranges to valid intervals.
    • Enable retry on failure to handle intermittent network or rate limit issues.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion