Graph API Version

Graph API Reference

This is a full list of the Graph API root nodes. The main difference between a root node and a non-root node is that root nodes can be queried directly, while non-root nodes can be queried via root nodes or edges. If you want to learn how to use the Graph API, read our Using Graph API guide, and if you want to know which APIs can solve some frequent issues, try our Common Scenarios guide.

Graph API Root Nodes

NodeDescription
/ad-account

An ad account is an account used for managing ads on Facebook.

/ad-campaign

An ad set is a group of ads that share the same daily or lifetime budget, schedule, bid type, bid info, and targeting data. Ad sets enable you to group ads according to your criteria, and you can retrieve the ad-related statistics that apply to a set.

/ad-campaign-group

A campaign is a grouping of ad sets which are organized by the same business objective. Each campaign has an objective that must be valid across the ad sets within that campaign.

After your ads begin delivering, you can query stats for ad campaigns. The statistics returned will be unique stats, deduped across the ad sets. You can also get reports and statistics for all ad sets and ads in an campaign simultaneously.
/ad-image

Image for use in ad creatives can be uploaded and managed independently of the ad itself. The image used in an ad creative can be specified in the following ways:

  • By image hash value of a previously uploaded image.
  • By uploading the image at ad or ad creative creation time.
/ad-label

An AdLabel

/adgroup

An ad object contains the data necessary to visually display an ad and associate it with a corresponding ad set.

/ads-pixel

A Custom Audience pixel is a small piece of JavaScript code that an advertiser places on every page of their website. This piece of code provides a set of lightweight functionalities for sending user-specific events and event-specific custom data to Facebook. Advertisers can use the Custom Audience pixel to capture intent information about how people are using their website. A single Custom Audience pixel is added to all pages of a website, and is then used to create website custom audiences

/app-request

An individual app request received by someone, sent by an app or another person

/application

A Facebook app

/application-context

Provides access to available social context edges for this app

/atlas-entity-export-file

An Atlas Entity Export File

/atlas-notification

An Atlas Notification

/atlas-price-plan

An Atlas Price Plan

/event

An event

/friend-list

This represents a user's friend list on Facebook

/life-event

Page milestone information

/mailing-address

A mailing address object

/offsite-pixel

Conversion pixels are used to signal events that happened while the user was browsing your website like viewing a product, registering or even adding a product to his cart. This pixel is best used in conjunction with oCPM to drive a particular event.

/open-graph-context

Social context

/page

A Facebook page

/photo

This represents a Photo on Facebook

/place

A place

/place-tag

A Place Tag

/product-catalog

A Product Catalog object

/product-feed

A Product Feed is a set of items uploaded or fetched from a business at once. You can have a single product feed to represent all of the items in your catalog. Or you can have multiple product feeds with each feed representing a single country or single division's products.

/product-feed-upload

A specific product feed upload attempt

/product-feed-upload-error

A Product Feed Upload Error object

/product-feed-upload-error-sample

A Sample of a Product Feed Upload Error object

/product-group

A Product Group object

/product-item

A Product Item object

/product-set

A Product Set object

/promotion-info

A promotional info for the post.

/reach-frequency-prediction

You can reach all Reach Frequency Prediction objects from one ad account, or reach a Reach Frequency Prediction object from a Reach Frequency Prediction ID. Specify the fields you wish to retrieve. Only the id is returned by default.

/user

Returns a single user node

/user-context

Social context for a person

/video

A Video

/video-broadcast

A video broadcast

/video-list

A playlist for videos

Achievement

Represents a person gaining a game achievement

Achievement Type

A games achievement type

Album

A photo album

App Link Host

An individual app link host object created by an app

Comment

A single comment

Conversation

A Facebook Messages conversation between a person and a Facebook Page

Debug Token

Debug token endpoint docs

Domain

A web domain claimed within Facebook Insights

Friendlist

The name of a group of friends created by a person on Facebook

Graph API /user.context/all_mutual_friends

A list of all the Facebook friends that the session user and the request user have in common.

Group

A Facebook group

Group Doc

A document in a Facebook group

Link

A link shared on Facebook

Message

A single message in Facebook Messenger

Milestone

A milestone for a Facebook Page

Notification

An individual unread Facebook notification

Object Comments

Comments on an object

Object Insights

Insights and metrics for an object

Object Likes

Likes for an object

Object Sharedposts

Shares of this object

Offer

An offer published by a Facebook Page

Payment

A single payment

Post

An individual entry in a feed. Feeds can be found on users, pages, apps, and groups

Profile

A profile, which can be a user, page, group or event

Request

An app request received by a person. A request can be sent by an app or another person

Status

A status message in a profile's feed

Test User

A test user associated with a Facebook app. Test users are created and associated using the /app/accounts/test-users edge or the App Dashboard.

Thread

A messages thread in Facebook Messenger

URL

Shares, app links, and Open Graph objects for a URL