Kadam icon

Kadam

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

Stats → Get Creative Stats By Creative IDs

AI-generated

Overview

This node interacts with the Kadam advertising platform API to retrieve performance statistics specifically filtered by creative IDs. It is designed to fetch detailed metrics about ad creatives over a specified date range, grouped by criteria such as date or creative ID. This operation is useful for advertisers and marketers who want to analyze the effectiveness of specific creatives in their campaigns.

Common scenarios include:

  • Monitoring the performance of selected ad creatives to optimize ad spend.
  • Comparing engagement metrics like impressions, clicks, and CTR across different creatives.
  • Generating reports on creative-level statistics for a given time period.

Example: An advertiser wants to get daily statistics for two specific creatives (IDs "789" and "101") over the past week, grouped by date, to evaluate which creative performs better.

Properties

Name Meaning
Creatives Comma-separated list of creative IDs to retrieve stats for (e.g., "789,101"). Users can obtain these IDs using the "Get Creatives" operation.
Group By How to group the statistics data. Options are:
- Date: Group stats by date.
- Campaign: Group stats by campaign (only applicable for campaign stats).
- Creative: Group stats by creative (for creative stats).
Date From Start date for the statistics query. Defaults to 7 days ago.
Date To End date for the statistics query. Defaults to today.
Sort Sorting parameters for the results, e.g., "views,-clicks" means ascending by views and descending by 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 the data, ignoring limit and offset.
Limit Maximum number of items to return per request if "Return All" is false. Default is 100.
Offset Number of items to skip before starting to return results if "Return All" is false. Default is 0.
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 node outputs an array of JSON objects representing the requested creative statistics. Each object contains fields corresponding to the selected output fields or all available fields if none are specified. Typical fields include:

  • creative_id: The ID of the creative.
  • impressions: Number of times the creative was shown.
  • clicks: Number of clicks received.
  • ctr: Click-through rate.
  • Other statistical metrics depending on the API response and requested fields.

The output does not include binary data; it is purely JSON-formatted statistics data.

Dependencies

  • Requires an active Kadam API credential with an API token and application ID configured in n8n.
  • Uses the Kadam REST API endpoint at https://api.kadam.net.
  • Requires internet connectivity to reach the Kadam API.
  • No additional external dependencies beyond the Kadam API and n8n environment.

Troubleshooting

  • Common Issues:

    • Invalid or missing creative IDs will result in no data or errors.
    • Date range errors if Date From is after Date To.
    • API rate limiting may cause temporary failures; enabling "Retry on Failure" can help mitigate this.
    • Incorrect sorting parameters may lead to unexpected ordering or API errors.
  • Error Messages:

    • API errors typically include an error description from the Kadam API. These should be reviewed to correct input parameters.
    • Network or authentication errors indicate issues with credentials or connectivity.
    • If the node returns no data, verify that the creative IDs exist and have statistics for the specified date range.

Links and References

  • Kadam API Documentation (official API docs, requires login)
  • Kadam platform user guides (available via Kadam support channels)

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

Discussion