This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
X Ads — Lua API Reference
This integration is generated from the official X Ads Postman collection and exposes 190 Ads API operations.
Authentication
Configure OAuth 1.0a user-context credentials:
api_keyapi_secretaccess_tokenaccess_token_secret
X Ads API access must be approved by X. Tools are marked with required_access_tier=approved_ads_api_access.
Runtime Notes
- Campaign, line item, creative, funding, and audience writes are marked
billing_sensitive.
- Stats job endpoints are marked
runtime_mode=async_job.
- If
account_id is configured, tools with an account_id path parameter can omit it.
Examples
local accounts = app.integrations.x_ads.x_ads_get_accounts({})
local campaigns = app.integrations.x_ads.x_ads_get_accounts_account_id_campaigns({
account_id = "account-id",
count = "25"
})
Raw agent markdown
# X Ads — Lua API Reference
This integration is generated from the official X Ads Postman collection and exposes 190 Ads API operations.
## Authentication
Configure OAuth 1.0a user-context credentials:
- `api_key`
- `api_secret`
- `access_token`
- `access_token_secret`
X Ads API access must be approved by X. Tools are marked with `required_access_tier=approved_ads_api_access`.
## Runtime Notes
- Campaign, line item, creative, funding, and audience writes are marked `billing_sensitive`.
- Stats job endpoints are marked `runtime_mode=async_job`.
- If `account_id` is configured, tools with an `account_id` path parameter can omit it.
## Examples
```lua
local accounts = app.integrations.x_ads.x_ads_get_accounts({})
local campaigns = app.integrations.x_ads.x_ads_get_accounts_account_id_campaigns({
account_id = "account-id",
count = "25"
})
```
local result = app.integrations.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"
})
print(result)
