Marketing API Version

Marketing APIs Reference

This is a full list of root nodes for the Facebook Marketing APIs, with links to the reference docs for each. The available edges are shown separately.

To gain an understanding of the architecture of the API and how to call root nodes and their edges, read the using the Graph API document.

The main root objects of the Marketing APIs are:

Root NodeRepresents

/<USER>

An ad user is a regular Facebook user who chooses to create ads. Each user may have a role on several ad accounts

/act_<AD_ACCOUNT_ID>

An ad account is an account object for managing ads

/<CAMPAIGN_GROUP_ID>

An ad object to define your campaigns' objective and contain one or more ad sets

/<AD_SET_ID>

An ad set object to contain all ads that share the same budget, schedule, bid, and targeting

/<ADGROUP_ID>

An ad group contains the data necessary for an ad, such as creative elements and measurement information

User

Edges of a user

EdgeRepresents

/adaccountgroups

A grouping of ad accounts for that user

/adaccounts

All ad accounts for that user

Ad Account

All collections of objects in the Marketing APIs sit under an ad account.

Edges of an ad account

EdgeRepresents

/adcampaign_groups

An ad object to define your campaigns' objective and contain one or more ad sets

/adcampaigns

An ad set object to contain all ads that share the same budget, schedule, bid, and targeting

/adgroup

An ad group contains the data necessary for an ad, such as creative elements and measurement information

/adcreatives

An ad creative object defines your ad's appearance

/adimages

A library of images for use in ad creatives. Can be uploaded and managed independently

/advideos

A library of videos for use in ad creatives. Can be uploaded and managed independently

/activities

A log of the actions taken on the ad account

/adtags

A set of tags in the ad account used to tag similar campaigns, ad sets, or ads

/connectionobjects

Facebook objects (e.g. pages, apps, etc) which the ad user is an administrator of (or developer/advertiser in the case of apps)

/conversions

Conversion data aggregated by the ad account

/adcampaignconversions

Conversion data aggregated by ad sets in the ad account

/adgroupconversions

Conversion data aggregated by ads in the ad account

/customaudiences

The ad account's custom audiences. Custom Audiences allow advertisers to target their ads to people with whom they already have a relationship off of Facebook

/generatepreviews

An API to generate ad previews

/offsitepixels

The conversion pixels created on the account

/partnercategories

The ad account's partner categories. Partner categories are targeting clusters created by our 3rd party data providers

/reachestimate

An API to generate the estimated reach of a specified targeting spec

/reportstats

A flexible reporting API to fetch ad account data and allows for scheduled reports

/stats

Returns a single set of statistics aggregated by the ad account

/adcampaignstats

Returns a single set of statistics aggregated by ad sets in the ad account

/adgroupstats

Returns a single set of statistics aggregated by ads in the ad account

/targetingsentencelines

An API to generate human-readable description of the targeting for the ad group

/users

A list of users on the ad account

/insights

Ad Insights API that provides a single consistent interface for insights. Features include deduping across child objects, sorting, async reports.

Ad Campaign

Edges of an ad campaign

EdgeRepresents

/adcampaigns

An ad set object to contain all ads that share the same budget, schedule, bid, and targeting.

/adgroup

An ad group contains the data necessary for an ad, such as creative elements and measurement information

/adtags

A tagging mechanism for your campaigns to easily find similar campaigns

/stats

Returns a single set of statistics aggregated by campaigns

/insights

Ad Insights API that provides a single consistent interface for insights. Features include deduping across child objects, sorting, async reports.

Ad Set

Edges of an ad set

EdgeRepresents

/adgroup

An ad group contains the data necessary for an ad, such as creative elements and measurement information

/adcreatives

An ad creative object is defines your ad's appearance

/activities

A log of the actions taken on the ad set

/adtags

A tagging mechanism for your ad sets to easily find similar ad sets

/conversions

Conversion data for the ad set

/stats

Returns a single set of statistics aggregated by ad sets

/insights

Ad Insights API that provides a single consistent interface for insights. Features include deduping across child objects, sorting, async reports.

Edges of an ad

EdgeRepresents

/adcreatives

An ad creative object is defines your ad's appearance

/adtags

A tagging mechanism for your ads to easily find similar ads

/conversions

Conversion data for the ad

/keywordstats

Returns stats per targeted keyword of the ad

/previews

An API to generate ad previews from the existing ad object

/reachestimate

An API to generate the estimated reach for an ad

/stats

Returns a single set of statistics for your ad

/targetingsentencelines

An API to generate a human-readable description of the targeting for the ad group

/trackingtag

An API to assign click tags to an ad. Click tracking tags allow an advertiser to specify a URL that will get fired upon a click on an ad.

/insights

Ad Insights API that provides a single consistent interface for insights. Features include deduping across child objects, sorting, async reports.

Creative

Edges of a creative

EdgeRepresents

/previews

An API to generate ad previews from the existing ad creative object