Metrics

Kwai Ads metrics via API

Your customer connects their Kwai Ads account and your product queries 31 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "kwai_ads:charge",
      "component": "number_v1",
      "metrics": [
        "cost"
      ]
    }
  ]
}
Example: "Amount Spent" in October, compared to September.

More Kwai Ads request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Chart

Spend over time

The total amount spent over time.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "kwai_ads:spend_by_day",
      "component": "chart_v1",
      "metrics": [
        "cost"
      ],
      "dimensions": [
        "stat_date"
      ]
    }
  ]
}

Table

Featured Campaigns

Campaigns with performance data for the selected period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "kwai_ads:campaigns_table",
      "component": "datatable_v1",
      "metrics": [
        "cost",
        "exposure",
        "click",
        "ctr",
        "action",
        "cpa"
      ],
      "dimensions": [
        "campaign_name"
      ]
    }
  ]
}

Number

Impressions

The number of times your ads were shown.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "kwai_ads:show",
      "component": "number_v1",
      "metrics": [
        "exposure"
      ]
    }
  ]
}

Numbers

23 metrics

  • Amount Spent

    The total amount spent on Kwai Ads during the selected period.

    kwai_ads:charge
  • Impressions

    The number of times your ads were shown.

    kwai_ads:show
  • Clicks

    The number of times users clicked your ad cover or creative.

    kwai_ads:photo_click
  • CTR

    The click-through rate for your ads.

    kwai_ads:photo_click_ratio
  • Asset Impressions

    The number of impressions generated by the promoted asset.

    kwai_ads:aclick
  • Actions

    The number of actions generated by your ads.

    kwai_ads:bclick
  • Action Rate

    The percentage of ad impressions that generated an action.

    kwai_ads:action_ratio
  • Cost per Action

    The average cost for each action generated by your ads.

    kwai_ads:action_cost
  • CPM

    The average cost per thousand impressions.

    kwai_ads:impression_1k_cost
  • 3s Video Plays

    The number of video plays that reached at least 3 seconds.

    kwai_ads:played_three_seconds
  • 3s Play Rate

    The percentage of impressions that generated a 3-second video play.

    kwai_ads:play_3s_ratio
  • 5s Play Rate

    The percentage of impressions that generated a 5-second video play.

    kwai_ads:play_5s_ratio
  • Completion Rate

    The percentage of video plays that reached completion.

    kwai_ads:play_end_ratio
  • Likes

    The number of likes generated by your ads.

    kwai_ads:like
  • Comments

    The number of comments generated by your ads.

    kwai_ads:comment
  • Shares

    The number of shares generated by your ads.

    kwai_ads:share
  • Follows

    The number of new follows generated by your ads.

    kwai_ads:follow
  • Conversions

    The number of conversions attributed to your ads.

    kwai_ads:conversion_num
  • Cost per Conversion

    The average cost for each conversion.

    kwai_ads:conversion_cost
  • Conversion Rate

    The percentage of actions that generated a conversion.

    kwai_ads:conversion_ratio
  • Deep Conversions

    The number of deep conversions attributed to your ads.

    kwai_ads:deep_conversion_num
  • Cost per Deep Conversion

    The average cost for each deep conversion.

    kwai_ads:deep_conversion_cost
  • Deep Conversion Rate

    The percentage of conversions that generated a deep conversion.

    kwai_ads:deep_conversion_ratio

Charts

3 metrics

  • Spend over time

    The total amount spent over time.

    kwai_ads:spend_by_day
  • Impressions and Clicks over time

    The number of impressions and clicks over time.

    kwai_ads:impressions_clicks_by_day
  • Conversions over time

    The number of conversions and deep conversions over time.

    kwai_ads:conversions_by_day

Tables

5 metrics

  • Featured Campaigns

    Campaigns with performance data for the selected period.

    kwai_ads:campaigns_table
  • Featured Ad Groups

    Ad groups with performance data for the selected period.

    kwai_ads:ad_groups_table
  • Featured Creatives

    Creatives with performance data for the selected period.

    kwai_ads:creatives_table
  • Audience by Age

    Performance grouped by age segment.

    kwai_ads:audience_by_age
  • Audience by Gender

    Performance grouped by gender.

    kwai_ads:audience_by_gender

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.