support Contact support
    • Kamino
    • Developers
    • Kamino platform API integration
    • Analyze campaign performance

    Extract campaign and line item performance data

    Table of Contents

    Overview Main endpoints Campaign settings Metrics Daily refresh time Hourly refresh time

    Overview

    This article explains how to extract data for a specific campaign and all its line items.

    Main endpoints

    Method Endpoint Description Link
    POST https://api.kaminoretail.dev/v3/analytics/get-campaign-performances Get campaign performance data for a specific campaignId across the selected analysis period. Get campaign performances
    POST https://api.kaminoretail.dev/v3/analytics/list-category-performances Get a hierarchical category tree with aggregated metrics for products and categories within a campaign. Get category and product performance metrics for a campaign
    POST https://api.kaminoretail.dev/v3/analytics/list-campaign-performances Get a list of campaign performances across the selected analysis period. Get a list of campaign performances

    Campaign settings

    Attribute Data type Description
    accountId integer ID associated with this campaign.
    brand integer or string ID and name of the campaign brand.
    budget string Campaign budget.
    creator string Email address and ID of the user who created the campaign.
    duration string Information about campaign duration: daysRemaining, elapsed, endDate, startDate.
    favorite boolean Information used by the Kamino UI.
    id integer Campaign ID.
    lineItemKinds array[string] List of line item kinds. Allowed values: guaranteed, unknown, ksp.
    name string Campaign name.
    status string Campaign status. Allowed values: programming, review, approved, rejected, running, paused, ended, deleted, archived.
    type string Campaign type. Allowed values: monetization.
    website integer or string Name and ID of the website associated with this campaign.

    Metrics

    Daily refresh time

    Attribute Data type Description
    adSpend integer Total amount spent on advertising.
    adSpendOptin integer or string Ad spend attributed to users who opted in to tracking on the retailer website.
    adSpendOptout string Ad spend attributed to users who opted out of tracking on the retailer website.
    attributedRevenue string Revenue attributed to the advertising campaign.
    returnOnAdSpend string Return on ad spend (ROAS). This metric represents the revenue generated per dollar spent and is calculated only for users who opted in.

    Hourly refresh time

    Attribute Data type Description
    adSpend string Total amount spent on advertising.
    clickThroughRate string Percentage of impressions that resulted in clicks.
    clicks integer Number of times users clicked on the ad.
    impressions integer Number of times the ad was displayed to users.
    onTarget string Budget pacing ratio. This metric represents the percentage of elapsed time compared with the percentage of the budget spent (100% means the campaign is on track).
    views integer Number of times users viewed the ad content.

    RELATED ARTICLES