Get facebook ad report

GET

https://api.mailchimp.com/3.0/reporting/facebook-ads/:outreach_id

GET

/3.0/reporting/facebook-ads/:outreach_id

curl https://api.mailchimp.com/3.0/reporting/facebook-ads/outreach_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "canceled_at": "2024-01-15T09:30:00Z",
  "create_time": "2024-01-15T09:30:00Z",
  "has_segment": true,
  "id": "string",
  "name": "string",
  "published_time": "2024-01-15T09:30:00Z",
  "recipients": {
    "list_id": "string",
    "list_is_active": true,
    "list_name": "string",
    "recipient_count": 1,
    "segment_opts": {
      "conditions": [
        {
          "condition_type": "Aim",
          "field": "aim",
          "op": "open",
          "value": "any"
        }
      ],
      "match": "any",
      "prebuilt_segment_id": "subscribers-female",
      "saved_segment_id": 1
    },
    "segment_text": "string"
  },
  "report_summary": {
    "click_rate": 1.1,
    "clicks": 1,
    "ecommerce": {
      "currency_code": "string",
      "total_revenue": 1.1
    },
    "impressions": 1,
    "reach": 1,
    "average_daily_budget": {
      "amount": 1.1,
      "currency_code": "string"
    },
    "average_order_amount": {
      "amount": 1.1,
      "currency_code": "string"
    },
    "comments": 1,
    "cost_per_click": {
      "amount": 1.1,
      "currency_code": "string"
    },
    "extended_at": {
      "datetime": "string",
      "timezone": "string"
    },
    "first_time_buyers": 1,
    "has_extended_ad_duration": true,
    "likes": 1,
    "return_on_investment": 1.1,
    "shares": 1,
    "total_orders": 1,
    "total_products_sold": 1,
    "unique_clicks": 1
  },
  "show_report": true,
  "start_time": "2024-01-15T09:30:00Z",
  "status": "save",
  "type": "regular",
  "updated_at": "2024-01-15T09:30:00Z",
  "web_id": 1,
  "email_source_name": "string",
  "end_time": "2024-01-15T09:30:00Z",
  "needs_attention": true,
  "paused_at": "2024-01-15T09:30:00Z",
  "thumbnail": "string",
  "was_canceled_by_facebook": true,
  "audience": {
    "email_source": {
      "is_segment": true,
      "list_name": "string",
      "name": "string",
      "segment_type": "string",
      "type": "string"
    },
    "include_source_in_target": true,
    "lookalike_country_code": "string",
    "source_type": "facebook",
    "targeting_specs": {
      "gender": 0,
      "interests": [
        {
          "name": "string"
        }
      ],
      "locations": {
        "cities": [
          "string"
        ],
        "countries": [
          "string"
        ],
        "regions": [
          "string"
        ],
        "zips": [
          "string"
        ]
      },
      "max_age": 1,
      "min_age": 1
    },
    "type": "Custom Audience"
  },
  "audience_activity": {
    "clicks": [
      {
        "clicks": 1,
        "date": "string"
      }
    ],
    "impressions": [
      {
        "date": "string",
        "impressions": 1
      }
    ],
    "revenue": [
      {
        "date": "string",
        "revenue": 1.1
      }
    ]
  },
  "budget": {
    "currency_code": "USD",
    "duration": 86400,
    "total_amount": 500
  },
  "channel": {
    "fb_placement_audience": false,
    "fb_placement_feed": true,
    "ig_placement_feed": false
  },
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ]
}

Get report of a Facebook ad.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

outreach_idstringRequired

The outreach id.

Query parameters

fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

Response

Facebook Ad report Instance

canceled_atdatetimeOptional

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

create_timedatetimeOptional

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

has_segmentbooleanOptional

If this outreach targets a segment of your audience.

idstringOptional

Unique ID of an Outreach.

namestringOptional

Title or name of an Outreach.

published_timedatetimeOptional

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

recipientsobjectOptional

High level audience information for who the outreach targets.

report_summaryobjectOptional

Report summary of facebook ad

show_reportbooleanOptional

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

start_timedatetimeOptional

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

statusenumOptional

The status of this outreach.

typeenumOptional

The type of outreach this object is.

updated_atdatetimeOptional

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

web_idintegerOptional

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_namestringOptional

end_timedatetimeOptional

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

needs_attentionbooleanOptional

If the ad has a problem and needs attention.

paused_atdatetimeOptional

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

thumbnailstringOptional

The URL of the thumbnail for this outreach.

was_canceled_by_facebookbooleanOptional

audienceobjectOptional

Audience settings

audience_activityobjectOptional

budgetobjectOptional

channelobjectOptional

Channel settings

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.