`microsoft_ads_get_audience_segment_report`

Get Microsoft Ads Audience Segment Report

Microsoft

Description

Read-onlyOpen-world

Usage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "microsoft_ads_get_audience_segment_report",
    "arguments": {}
  }
}

hopkin microsoft audience-segment-report get

Flag	Type	Required	Description
`--account`	`string`	Required	Microsoft Advertising account ID (AccountId). Required.
`--customer-id`	`string`	Optional	Customer/manager ID (CustomerId). Required when accessing accounts under a manager hierarchy.
`--date-range`	`object`	Optional	Custom date range. Provide either date_range or date_preset.
`--date-preset`	`string`	Optional	Predefined date range: Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear.
`--campaign-ids`	`array`	Optional	Filter to specific campaign IDs (up to 100). Accepts JSON-string or actual array.
`--ad-group-ids`	`array`	Optional	Narrow the report to these ad group IDs (up to 100). Each ad group's parent campaign is read from the local cache, or looked up under campaign_ids when given. With campaign_ids, every ad group must belong to one of those campaigns, and the report covers only the listed ad groups. An ad group that cannot be resolved is rejected with an error, never silently widened.
`--account-status`	`array`	Optional	Filter by account status: Active, Paused, Deleted.
`--campaign-status`	`array`	Optional	Filter by campaign status: Active, Paused, Deleted.
`--ad-group-status`	`array`	Optional	Filter by ad group status: Active, Paused, Deleted.
`--aggregation`	`string`	Optional	Report aggregation period. Summary (default — collapses dates), Daily, Weekly, Monthly. TimePeriod column is added automatically when aggregation is not Summary.
`--include-all-conversions`	`boolean`	Optional	When true, adds an all_conversions sub-object to each row containing AllConversionsQualified (all goals, including non-bidding), AllRevenue, ViewThroughConversionsQualified, and derived all_cost_per_conversion / all_roas. Mirrors the google-ads-mcp include_all_conversions opt-in. Default: false.
`--breakdown-by-goal`	`boolean`	Optional	When true (default), runs a parallel GoalsAndFunnelsReport and attaches goal_breakdown keyed by campaign_id to the response. Granularity is campaign-level (segment-level goal join is not supported by Bing). Set to false to skip the parallel call when latency matters more than goal split.
`--include-video-metrics`	`boolean`	Optional	Include VideoViews, ViewThroughRate, AverageCPV, VideoCompletionRate, CompletedVideoViews (Audience Network / video placements only).
`--order-by`	`string`	Optional	Sort rows server-side (descending) before applying limit. Options: spend, impressions, clicks, conversions, ctr, bid_adjustment. Default: spend.
`--limit`	`integer`	Optional	Page size: rows per page (1–10000, default 1000). count is the total across all pages. When more rows remain the response carries nextCursor; pass it back as cursor to get the next page.
`--cursor`	`string`	Optional	Opaque pagination cursor. Omit for the first page. To fetch the next page, pass the nextCursor value from the previous response unchanged and repeat every other parameter exactly (only limit may change); a cursor used with different parameters is rejected. Later pages re-read the same report, so a cursor expires with it (about 24 hours).
`--connection-id`	`string`	Optional	Optional ID of a specific connection to use for this call. Omit to use the actor's default connection for this network. Call <platform>_list_connections to discover available connection IDs.

{
  "mcpServers": {
    "microsoft-ads": {
      "url": "https://microsoft.mcp.hopkin.ai",
      "transport": "sse"
    }
  }
}

Parameters

Name	Type	Required	Description
`account_id`	`string`	Required	Microsoft Advertising account ID (AccountId). Required.minLength: 1
`reason`	`string`	Required	Why this tool call is neededminLength: 1, maxLength: 500

Optional parameters (16)

Name	Type	Required	Description
`customer_id`	`string`	Optional	Customer/manager ID (CustomerId). Required when accessing accounts under a manager hierarchy.minLength: 1
`date_range`	`object`	Optional	Custom date range. Provide either date_range or date_preset.
`date_preset`	`string`	Optional	Predefined date range: Today, Yesterday, LastSevenDays, ThisWeek, LastWeek, LastFourWeeks, ThisMonth, LastMonth, LastThreeMonths, LastSixMonths, ThisYear, LastYear. `Today` `Yesterday` `LastSevenDays` `ThisWeek` `LastWeek` `LastFourWeeks` `ThisMonth` `LastMonth` `LastThreeMonths` `LastSixMonths` `ThisYear` `LastYear`
`campaign_ids`	`array`	Optional	Filter to specific campaign IDs (up to 100). Accepts JSON-string or actual array.
`ad_group_ids`	`array`	Optional	Narrow the report to these ad group IDs (up to 100). Each ad group's parent campaign is read from the local cache, or looked up under campaign_ids when given. With campaign_ids, every ad group must belong to one of those campaigns, and the report covers only the listed ad groups. An ad group that cannot be resolved is rejected with an error, never silently widened.
`account_status`	`array`	Optional	Filter by account status: Active, Paused, Deleted.
`campaign_status`	`array`	Optional	Filter by campaign status: Active, Paused, Deleted.
`ad_group_status`	`array`	Optional	Filter by ad group status: Active, Paused, Deleted.
`aggregation`	`string`	Optional	Report aggregation period. Summary (default — collapses dates), Daily, Weekly, Monthly. TimePeriod column is added automatically when aggregation is not Summary. `Summary` `Daily` `Weekly` `Monthly`
`include_all_conversions`	`boolean`	Optional	When true, adds an all_conversions sub-object to each row containing AllConversionsQualified (all goals, including non-bidding), AllRevenue, ViewThroughConversionsQualified, and derived all_cost_per_conversion / all_roas. Mirrors the google-ads-mcp include_all_conversions opt-in. Default: false.
`breakdown_by_goal`	`boolean`	Optional	When true (default), runs a parallel GoalsAndFunnelsReport and attaches goal_breakdown keyed by campaign_id to the response. Granularity is campaign-level (segment-level goal join is not supported by Bing). Set to false to skip the parallel call when latency matters more than goal split.
`include_video_metrics`	`boolean`	Optional	Include VideoViews, ViewThroughRate, AverageCPV, VideoCompletionRate, CompletedVideoViews (Audience Network / video placements only).
`order_by`	`string`	Optional	Sort rows server-side (descending) before applying limit. Options: spend, impressions, clicks, conversions, ctr, bid_adjustment. Default: spend. `spend` `impressions` `clicks` `conversions` `ctr` `bid_adjustment`
`limit`	`integer`	Optional	Page size: rows per page (1–10000, default 1000). count is the total across all pages. When more rows remain the response carries nextCursor; pass it back as cursor to get the next page.min: 1, max: 10000
`cursor`	`string`	Optional	Opaque pagination cursor. Omit for the first page. To fetch the next page, pass the nextCursor value from the previous response unchanged and repeat every other parameter exactly (only limit may change); a cursor used with different parameters is rejected. Later pages re-read the same report, so a cursor expires with it (about 24 hours).minLength: 1
`connection_id`	`string`	Optional	Optional ID of a specific connection to use for this call. Omit to use the actor's default connection for this network. Call <platform>_list_connections to discover available connection IDs.