Kadam icon

Kadam

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

Actions24

Stats → Get Creative Stats By Campaign IDs

AI-generated

Overview

This node interacts with the Kadam advertising platform API to retrieve creative statistics filtered by specified campaign IDs. It is useful for advertisers and marketers who want to analyze the performance of creatives within particular campaigns over a defined date range. For example, you can use this node to get impressions, clicks, CTR, and other metrics grouped by date or creative for selected campaigns, helping optimize ad creatives based on their effectiveness.

Properties

Name Meaning
Campaigns List of campaign IDs to retrieve stats for. You must select one or more campaigns (IDs can be obtained using the "Get Campaigns" operation).
Group By How to group the statistics data. Options: Date (group by date), Creative (group by creative). For this operation, grouping by campaign is not applicable.
Date From Start date for statistics retrieval. Defaults to 7 days ago.
Date To End date for statistics retrieval. 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 JSON. Supports dot notation for nested fields (e.g., stats.impressions). If empty, all fields are returned. Example: creative_id,impressions,clicks,ctr.

Output

The node outputs an array of JSON objects representing the creative statistics filtered by the specified campaign IDs and grouped according to the selected option. Each object contains statistical fields such as impressions, clicks, CTR, and identifiers like creative ID and campaign ID depending on the grouping.

  • The exact fields included depend on the "Output Fields" property; if left empty, all available fields from the API response are included.
  • The output does not include binary data.

Example output JSON snippet:

{
  "creative_id": "12345",
  "date": "2024-06-01",
  "impressions": 1000,
  "clicks": 50,
  "ctr": 0.05
}

Dependencies

  • Requires an API key credential for authenticating with the Kadam API.
  • The node uses the Kadam API base URL https://api.kadam.net.
  • Requires proper configuration of the Kadam API credentials in n8n.
  • Relies on the Kadam API's availability and correct permissions for accessing campaign and creative statistics.

Troubleshooting

  • Common Issues:

    • Invalid or expired API token: Ensure your API key credential is valid and has not expired.
    • Rate limiting errors: Use the "Retry on Failure" option to automatically retry requests on temporary rate limits.
    • Empty or missing campaign IDs: Make sure to provide valid campaign IDs obtained from the "Get Campaigns" operation.
    • Incorrect date ranges: Verify that "Date From" is earlier than "Date To".
    • Invalid output fields: If specifying "Output Fields", ensure field names match those provided by the Kadam API.

  • Error Messages:

    • "Unsupported resource": Occurs if the resource parameter is incorrect; ensure "Stats" resource is selected.
    • API error messages returned from Kadam will be wrapped with additional context; check the message and description for details.
    • Network or connectivity errors: Check internet connection and Kadam API status.

Links and References

Discussion