marketing
X Ads CLI for Headless Automation
Use the X Ads CLI for headless automation with headless JSON commands, schema discovery, credentials, and permission controls.
190 functions 99 read 91 write oauth1a user context auth
X Ads CLI for Headless Automation
Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers.
Use headless automation when another tool needs a stable local command surface. The X Ads CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# X Ads CLI for Headless Automation
kosmokrator integrations:configure x_ads --set api_key="$X_ADS_API_KEY" --set api_secret="$X_ADS_API_SECRET" --set access_token="$X_ADS_ACCESS_TOKEN" --set access_token_secret="$X_ADS_ACCESS_TOKEN_SECRET" --enable --read allow --write ask --json
kosmo integrations:call x_ads.x_ads_get_stats_accounts_account_id_active_entities '{"account_id":"example_account_id","end_time":"example_end_time","entity":"example_entity","start_time":"example_start_time","campaign_ids":"example_campaign_ids","funding_instrument_ids":"example_funding_instrument_ids","line_item_ids":"example_line_item_ids"}' --json Discovery Before Execution
Agents and scripts can inspect X Ads docs and schemas before choosing a function.
kosmo integrations:docs x_ads --json
kosmo integrations:docs x_ads.x_ads_get_stats_accounts_account_id_active_entities --json
kosmo integrations:schema x_ads.x_ads_get_stats_accounts_account_id_active_entities --json
kosmo integrations:search "X Ads" --json
kosmo integrations:list --json Useful X Ads CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
x_ads.x_ads_get_stats_accounts_account_id_active_entities | Read | account_id, end_time, entity, start_time, campaign_ids, funding_instrument_ids, line_item_ids | X Ads API operation: Analytics / Active Entities stats/accounts/:account_id/active_entities. |
x_ads.x_ads_get_stats_jobs_accounts_account_id | Read | account_id, count, cursor, job_ids | X Ads API operation: Analytics / Asynchronous Analytics stats/jobs/accounts/:account_id. |
x_ads.x_ads_post_stats_jobs_accounts_account_id | Write | account_id, end_time, entity, entity_ids, granularity, metric_groups, placement, start_time, country, platform, segmentation_type | X Ads API operation: Analytics / Asynchronous Analytics stats/jobs/accounts/:account_id. |
x_ads.x_ads_delete_stats_jobs_accounts_account_id_job_id | Write | account_id, body | X Ads API operation: Analytics / Asynchronous Analytics stats/jobs/accounts/:account_id/:job_id. |
x_ads.x_ads_get_accounts_account_id_auction_insights | Read | account_id, end_time, granularity, line_item_ids, placement, start_time | X Ads API operation: Analytics / Auction Insights accounts/:account_id/auction_insights. |
x_ads.x_ads_get_stats_accounts_account_id_reach_campaigns | Read | account_id, campaign_ids, end_time, start_time | X Ads API operation: Analytics / Reach and Average Frequency stats/accounts/:account_id/reach/campaigns. |
x_ads.x_ads_get_stats_accounts_account_id_reach_funding_instruments | Read | account_id, funding_instrument_ids, end_time, start_time | X Ads API operation: Analytics / Reach and Average Frequency stats/accounts/:account_id/reach/funding_instruments. |
x_ads.x_ads_get_stats_accounts_account_id | Read | account_id, end_time, entity, entity_ids, granularity, metric_groups, placement, start_time | X Ads API operation: Analytics / Synchronous Analytics stats/accounts/:account_id. |
x_ads.x_ads_get_insights_accounts_account_id | Read | account_id, audience_type, audience_value, interaction_type | X Ads API operation: Audience / Insights insights/accounts/:account_id. |
x_ads.x_ads_get_insights_accounts_account_id_available_audiences | Read | account_id | X Ads API operation: Audience / Insights insights/accounts/:account_id/available_audiences. |
x_ads.x_ads_get_insights_keywords_search | Read | granularity, keywords, start_time, end_time, location, negative_keywords | X Ads API operation: Audience / Keyword Insights insights/keywords/search. |
x_ads.x_ads_get_accounts_account_id_tailored_audiences_tailored_audience_id_permissions | Read | account_id, count, cursor, granted_account_ids, sort_by, tailored_audience_permission_ids, with_total_count | X Ads API operation: Audience / Tailored Audience Permissions accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions. |
x_ads.x_ads_post_accounts_account_id_tailored_audiences_tailored_audience_id_permissions | Write | account_id, granted_account_id, permission_level | X Ads API operation: Audience / Tailored Audience Permissions accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions. |
x_ads.x_ads_delete_accounts_account_id_tailored_audiences_tailored_audience_id_permissions_tailored_audience_permission_id | Write | account_id, tailored_audience_permission_id, body | X Ads API operation: Audience / Tailored Audience Permissions accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id. |
x_ads.x_ads_get_accounts_account_id_tailored_audiences | Read | account_id, count, cursor, permission_scope, q, sort_by, tailored_audience_ids, with_deleted, with_total_count | X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences. |
x_ads.x_ads_get_accounts_account_id_tailored_audiences_tailored_audience_id | Read | account_id, with_deleted | X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences/:tailored_audience_id. |
x_ads.x_ads_post_accounts_account_id_tailored_audiences | Write | account_id, name | X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences. |
x_ads.x_ads_post_batch_accounts_account_id_tailored_audiences | Write | account_id, audience_type, child_segments, name, operation_type, params, boolean_operator, lookback_window, segments, tailored_audience_id, frequency, frequency_comparator, negate | X Ads API operation: Audience / Tailored Audiences batch/accounts/:account_id/tailored_audiences. |
x_ads.x_ads_delete_accounts_account_id_tailored_audiences_tailored_audience_id | Write | account_id, body | X Ads API operation: Audience / Tailored Audiences accounts/:account_id/tailored_audiences/:tailored_audience_id. |
x_ads.x_ads_post_accounts_account_id_tailored_audiences_tailored_audience_id_users | Write | account_id, operation_type, params, users, effective_at, expires_at | X Ads API operation: Audience / Tailored Audiences Users accounts/:account_id/tailored_audiences/:tailored_audience_id/users. |
x_ads.x_ads_get_accounts | Read | account_ids, count, cursor, q, sort_by, with_deleted, with_total_count | X Ads API operation: Campaign Management / Accounts accounts. |
x_ads.x_ads_get_accounts_account_id | Read | account_id, with_deleted | X Ads API operation: Campaign Management / Accounts accounts/:account_id. |
x_ads.x_ads_post_accounts | Write | none | X Ads API operation: Campaign Management / Accounts accounts. |
x_ads.x_ads_put_accounts_account_id | Write | account_id, name, industry_type | X Ads API operation: Campaign Management / Accounts accounts/:account_id. |
x_ads.x_ads_delete_accounts_account_id | Write | account_id | X Ads API operation: Campaign Management / Accounts accounts/:account_id. |
x_ads.x_ads_get_accounts_account_id_authenticated_user_access | Read | account_id | X Ads API operation: Campaign Management / Authenticated User Access accounts/:account_id/authenticated_user_access. |
x_ads.x_ads_get_bidding_rules | Read | currency | X Ads API operation: Campaign Management / Bidding Rules bidding_rules. |
x_ads.x_ads_get_accounts_account_id_campaigns | Read | account_id, campaign_ids, count, cursor, funding_instrument_ids, q, sort_by, with_deleted, with_draft, with_total_count | X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns. |
x_ads.x_ads_get_accounts_account_id_campaigns_campaign_id | Read | account_id, with_deleted | X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns/:campaign_id. |
x_ads.x_ads_post_accounts_account_id_campaigns | Write | account_id, funding_instrument_id, name, start_time, daily_budget_amount_local_micro, duration_in_days, end_time, entity_status, frequency_cap, standard_delivery, total_budget_amount_local_micro | X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns. |
x_ads.x_ads_post_batch_accounts_account_id_campaigns | Write | account_id, operation_type, params | X Ads API operation: Campaign Management / Campaigns batch/accounts/:account_id/campaigns. |
x_ads.x_ads_put_accounts_account_id_campaigns_campaign_id | Write | account_id, daily_budget_amount_local_micro, end_time, entity_status, duration_in_days, frequency_cap, name, standard_delivery, start_time, total_budget_amount_local_micro | X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns/:campaign_id. |
x_ads.x_ads_delete_accounts_account_id_campaigns_campaign_id | Write | account_id | X Ads API operation: Campaign Management / Campaigns accounts/:account_id/campaigns/:campaign_id. |
x_ads.x_ads_get_content_categories | Read | none | X Ads API operation: Campaign Management / Content Categories content_categories. |
x_ads.x_ads_get_accounts_account_id_features | Read | account_id, feature_keys | X Ads API operation: Campaign Management / Features accounts/:account_id/features. |
x_ads.x_ads_post_accounts_account_id_features | Write | account_id, feature_keys | X Ads API operation: Campaign Management / Features accounts/:account_id/features. |
x_ads.x_ads_delete_accounts_account_id_features | Write | account_id, feature_keys | X Ads API operation: Campaign Management / Features accounts/:account_id/features. |
x_ads.x_ads_get_accounts_account_id_funding_instruments | Read | account_id, count, cursor, funding_instrument_ids, sort_by, with_deleted, with_total_count | X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments. |
x_ads.x_ads_get_accounts_account_id_funding_instruments_funding_instrument_id | Read | account_id, funding_instrument_id, with_deleted | X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments/:funding_instrument_id. |
x_ads.x_ads_post_accounts_account_id_funding_instruments | Write | account_id, currency, start_time, type, end_time, credit_limit_local_micro, funded_amount_local_micro | X Ads API operation: Campaign Management / Funding Instruments accounts/:account_id/funding_instruments. |
Showing 40 of 190 functions. See the X Ads CLI reference for every function.
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.