MAmailchimp
facebook-ads

Get facebook ad info

Get details of a Facebook ad.

get/3.0/facebook-ads/{outreach_id}

Request

Path parameters

outreach_idstring required

The outreach id.

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.

Response

Facebook Ad Instance

canceled_atstring date-time

The date and time the outreach was canceled in ISO 8601 format.

create_timestring date-time

The date and time the outreach was created in ISO 8601 format.

has_segmentboolean

If this outreach targets a segment of your audience.

idstring

Unique ID of an Outreach.

namestring

Title or name of an Outreach.

published_timestring date-time

The date and time the outreach was (or will be) published in ISO 8601 format.

show_reportboolean

Outreach report availability. Note: This property is hotly debated in what it should convey. See MCP-1371 for more context.

start_timestring date-time

The date and time the outreach was started in ISO 8601 format.

status'save' | 'paused' | 'schedule' | 'scheduled' | 'sending' | 'sent' | 'canceled' | 'canceling' | 'active' | 'disconnected' | 'somepaused' | 'draft' | 'completed' | 'partialRejected' | 'pending' | 'rejected' | 'published' | 'unpublished'

The status of this outreach.

type'regular' | 'email-touchpoint' | 'plaintext' | 'rss' | 'reconfirm' | 'variate' | 'absplit' | 'automation' | 'facebook' | 'google' | 'autoresponder' | 'transactional' | 'page' | 'website' | 'social_post' | 'survey' | 'customer_journey' | 'sms'

The type of outreach this object is.

updated_atstring date-time

The date and time the outreach was last updated in ISO 8601 format.

web_idinteger

The ID used in the Mailchimp web application. For example, for a regular outreach, you can view this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.

email_source_namestring
end_timestring date-time

The date and time the ad was ended in ISO 8601 format.

needs_attentionboolean

If the ad has a problem and needs attention.

paused_atstring date-time

The date and time the ad was paused in ISO 8601 format.

thumbnailstring

The URL of the thumbnail for this outreach.

was_canceled_by_facebookboolean
has_audienceboolean

Check if this ad has audience setup

has_contentboolean

Check if this ad has content

is_connectedboolean

Check if this ad is connected to a facebook page

Example response

{
  "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.