MAmailchimp
facebook-ads

List facebook ads

Get list of Facebook ads.

get/3.0/facebook-ads

Request

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

sort_field'created_at' | 'updated_at' | 'end_time'

Returns files sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

Response

List of Facebook Ad Instances

total_itemsinteger

The total number of items matching the query regardless of pagination.

Example response

{
  "facebook_ads": [
    {
      "recipients": {
        "segment_opts": {
          "conditions": [
            {
              "field": "aim",
              "op": "open",
              "value": "any"
            }
          ],
          "prebuilt_segment_id": "subscribers-female"
        }
      },
      "budget": {
        "currency_code": "USD",
        "duration": 86400,
        "total_amount": 500
      },
      "channel": {
        "fb_placement_feed": true
      },
      "site": {
        "id": 43,
        "name": "My Connected Site",
        "url": "www.example.com"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.