Kadam icon

Kadam

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

Actions24

Stats → Get Placement Stats

AI-generated

Overview

The "Get Placement Stats" operation of the Kadam node retrieves performance statistics related to ad placements within specified campaigns over a defined date range. This operation is useful for advertisers and marketers who want detailed insights into how different ad placements are performing, such as impressions, clicks, and click-through rates (CTR). It helps optimize advertising strategies by analyzing placement-level data.

Common scenarios:

  • Analyzing which placements generate the most engagement or conversions.
  • Comparing performance metrics across multiple campaigns.
  • Monitoring trends in placement effectiveness over time.

Practical example:
A marketing analyst wants to evaluate the effectiveness of various ad placements used in several campaigns during the past week. They use this node to fetch placement stats filtered by campaign IDs and date range, then sort results by views and clicks to identify top-performing placements.

Properties

Name Meaning
Campaigns List of campaign IDs to retrieve placement stats for. Users must select one or more campaigns. Campaign IDs can be obtained using the "Get Campaigns" operation.
Date From Start date for the statistics period. Defaults to 7 days ago from today. Defines the beginning of the date range for which stats are retrieved.
Date To End date for the statistics period. Defaults to today. Defines the end of the date range for which stats are retrieved.
Sort Sorting parameters for the results. Accepts comma-separated fields with optional "-" prefix for descending order. Example: "views,-clicks" sorts ascending by views and descending by clicks.
Retry on Failure Boolean flag indicating whether 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 settings.
Limit Maximum number of items to return per request when "Return All" is false. Defaults to 100.
Offset Number of items to skip before starting to return results when "Return All" is false. Defaults to 0.
Output Fields Optional comma-separated list of specific fields to include in the output JSON. Supports dot notation for nested fields (e.g., stats.impressions). If empty, all available fields are returned.

Output

The node outputs an array of JSON objects representing placement statistics for the selected campaigns and date range. Each object contains fields such as placement identifiers and various performance metrics like impressions, clicks, and CTR.

  • The exact fields included depend on the "Output Fields" property; if left empty, all available data fields are returned.
  • The output does not include binary data; it is purely JSON-formatted statistical data.

Example output snippet (fields may vary):

{
  "placement": "12345",
  "impressions": 10000,
  "clicks": 150,
  "ctr": 0.015,
  "date": "2024-06-01"
}

Dependencies

  • Requires an API key credential for authenticating with the Kadam API.
  • The node communicates with the Kadam API endpoint at https://api.kadam.net.
  • Proper configuration of the API token and application ID credentials is necessary.
  • Network connectivity to the Kadam API service is required.

Troubleshooting

  • Common issues:

    • Invalid or missing campaign IDs: Ensure that valid campaign IDs are provided, which can be fetched using the "Get Campaigns" operation.
    • Date range errors: Verify that "Date From" is earlier than or equal to "Date To".
    • API authentication failures: Confirm that the API key credential is correctly configured and has sufficient permissions.
    • Rate limiting or network errors: Enable "Retry on Failure" to allow automatic retries on transient errors.

  • Error messages:

    • "Unsupported resource": Occurs if the resource parameter is incorrect; ensure "Stats" is selected.
    • API error responses with descriptions will be surfaced; check the message and description for details.
    • If the node returns no data or unexpected formats, verify input parameters and API availability.

Links and References

Discussion