account | DynamicAccount | Yes | - | Select the X Ads account whose ads (promoted posts) should be listed. |
ad_ids | string or array of string | No | - | Scope to specific ad (promoted tweet) IDs (list or comma-separated string, up to 200). |
ad_group_ids | string or array of string | No | - | Scope to ads under specific ad group (line item) IDs (list or comma-separated string, up to 200). |
sort_by | string | No | - | Sort by a supported attribute, e.g. ‘created_at-desc’ or ‘updated_at-asc’. |
with_deleted | boolean | No | False | Include deleted ads. |
include_post_details | boolean | No | True | Attach each promoted post’s full post object (text, media, author) under a ‘tweet’ key, fetched from the account’s posts endpoint. Default: true. |
filters | array of FilterItem | No | - | Additional filters applied to the returned ads. The available fields to filter by are: - id: Filter by ad (promoted tweet) ID - tweet_id: Filter by the promoted post’s ID - line_item_id: Filter by parent ad group ID - entity_status: Filter by status Filters are combined using AND logic. If you want to use OR logic, use relevant operators like REGEXP_MATCH or IN_LIST. |
limit | integer | No | 100 | Maximum number of ads to return. Default: 100. |