Metrics

Microsoft Ads metrics via API

Your customer connects their Microsoft Ads account and your product queries 36 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": "microsoft_ads:impressions",
      "component": "number_v1",
      "metrics": [
        "impressions"
      ]
    }
  ]
}
Example: "Impressions" in October, compared to September.

More Microsoft 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

Impressions and clicks over time

The number of impressions and clicks your ads received 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": "microsoft_ads:impressions_clicks_by_day",
      "component": "chart_v1",
      "metrics": [
        "impressions",
        "clicks"
      ],
      "dimensions": [
        "day"
      ]
    }
  ]
}

Table

Featured campaigns

Campaigns that had the greatest impact on your audience during the analyzed 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": "microsoft_ads:featured_campaigns",
      "component": "datatable_v1",
      "metrics": [
        "impressions",
        "clicks",
        "ctr",
        "spend",
        "conversions",
        "conversion_rate",
        "average_cpc"
      ],
      "dimensions": [
        "campaign"
      ]
    }
  ]
}

Number

Clicks

The number of times users clicked on your ad

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": "microsoft_ads:clicks",
      "component": "number_v1",
      "metrics": [
        "clicks"
      ]
    }
  ]
}

Numbers

21 metrics

  • Impressions

    The number of times your ad was shown to users

    microsoft_ads:impressions
  • Clicks

    The number of times users clicked on your ad

    microsoft_ads:clicks
  • Amount spent

    The total amount spent on your campaigns

    microsoft_ads:spend
  • Conversions

    The number of conversions attributed to your ads

    microsoft_ads:conversions
  • All conversions

    Total conversions including cross-device and cross-browser conversions

    microsoft_ads:all_conversions
  • CPA of all conversions

    The average cost per conversion considering all conversions

    microsoft_ads:all_conversions_cpa
  • All conversions rate

    The conversion rate considering all conversions, calculated as all conversions divided by clicks

    microsoft_ads:all_conversions_rate
  • All conversions revenue

    The total revenue from all conversions including cross-device conversions

    microsoft_ads:all_conversions_revenue
  • ROAS of all conversions

    Return on ad spend considering all conversions, calculated as all conversions revenue divided by spend

    microsoft_ads:all_conversions_roas
  • Conversion value

    The total value of all conversions

    microsoft_ads:conversion_value
  • Revenue

    The total revenue generated from conversions

    microsoft_ads:revenue
  • CTR (Click through rate)

    The percentage of impressions that resulted in clicks

    microsoft_ads:ctr
  • Average CPC

    The average cost per click

    microsoft_ads:average_cpc
  • Average CPM

    The average cost per thousand impressions

    microsoft_ads:average_cpm
  • Conversion rate

    The percentage of clicks that resulted in conversions

    microsoft_ads:conversion_rate
  • Cost per conversion

    The average cost for each conversion

    microsoft_ads:cost_per_conversion
  • ROAS (Return on ad spend)

    The return on ad spend calculated as revenue divided by spend

    microsoft_ads:roas
  • Quality score

    A measure of the quality and relevance of your ads, keywords, and landing pages

    microsoft_ads:quality_score
  • Impression share

    The estimated percentage of impressions out of the total available impressions in the market you were targeting

    microsoft_ads:impression_share
  • Top impression rate

    The percentage of times your ad was shown in the top positions above organic search results

    microsoft_ads:top_impression_rate
  • Absolute top impression rate

    The percentage of times your ad was in the first position of all results

    microsoft_ads:absolute_top_impression_rate

Charts

9 metrics

  • Impressions and clicks over time

    The number of impressions and clicks your ads received over time

    microsoft_ads:impressions_clicks_by_day
  • Spend over time

    The total amount spent on your campaigns over time

    microsoft_ads:spend_by_day
  • Conversions over time

    The number of conversions over time

    microsoft_ads:conversions_by_day
  • Clicks and CTR over time

    The number of clicks and click-through rate over time

    microsoft_ads:clicks_ctr_by_day
  • Clicks by device

    Distribution of clicks by device type (Desktop, Mobile, Tablet)

    microsoft_ads:clicks_by_device
  • Impressions by device

    Distribution of impressions by device type

    microsoft_ads:impressions_by_device
  • Spend by device

    Distribution of spend by device type

    microsoft_ads:spend_by_device
  • Clicks by age

    Distribution of clicks by age group. Available only for campaigns with audience targeting or running on the Microsoft Audience Network.

    microsoft_ads:clicks_by_age
  • Clicks by gender

    Distribution of clicks by gender. Available only for campaigns with audience targeting or running on the Microsoft Audience Network.

    microsoft_ads:clicks_by_gender

Tables

6 metrics

  • Featured campaigns

    Campaigns that had the greatest impact on your audience during the analyzed period.

    microsoft_ads:featured_campaigns
  • Ad groups

    Summary of key data for ad groups during the analyzed period.

    microsoft_ads:ad_groups
  • Top keywords

    Keywords that performed best during the analyzed period.

    microsoft_ads:keywords
  • Featured ads

    Your ads performance during the analyzed period.

    microsoft_ads:ads
  • Geographic performance

    Summary of key data by geographic location.

    microsoft_ads:insights_by_geographic
  • Device performance

    Summary of key data by device type.

    microsoft_ads:insights_by_device

See Connect applied to your product.

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