Graph API Version

Application

Reading

A Facebook app

Example

Graph API Explorer
GET /v3.0/{application-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{application-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{application-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{application-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{application-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The app ID

an_ad_space_limit
unsigned int32

The maximum number ofAd Spaces allowed for each Audience Network supported platform

an_platforms
list<enum>

The platforms associated with the app in the Audience Network product. Not enforced, but when present, it can be used to provide the user with platform specific information for the app and its placements

app_domains
list<string>

Domains and subdomains this app can use

app_install_tracked
bool

Whether the app install is trackable or not

app_name
string

App name

app_type
unsigned int32

App type

auth_dialog_data_help_url
string

The URL of a special landing page that helps people who are using an app begin publishing Open Graph activity

auth_dialog_headline
string

One line description of an app that appears in the Login Dialog

auth_dialog_perms_explanation
string

The text to explain why an app needs additional permissions. This appears in the Login Dialog

auth_referral_default_activity_privacy
string

The default privacy setting selected for Open Graph activities in the Auth Dialog

auth_referral_enabled
unsigned int32

Indicates whether Authenticated Referrals are enabled

auth_referral_extended_perms
list<string>

Extended permissions that a person can choose to grant when Authenticated Referrals are enabled

auth_referral_friend_perms
list<string>

Basic friends permissions that a user must grant when Authenticated Referrals are enabled

auth_referral_response_type
string

The format that an app receives for the authentication token from the Login Dialog

auth_referral_user_perms
list<string>

Basic user permissions that a user must grant when Authenticated Referrals are enabled

business
Business

Business owner of this app

canvas_fluid_height
bool

Indicates whether the app uses fluid or settable height values for Canvas

canvas_fluid_width
unsigned int32

Indicates whether the app uses fluid or fixed width values for Canvas

canvas_url
string

The non-secure URL from which Canvas app content is loaded

category
string

The category of the app

client_config
map

Config data for the client

company
string

The company the app belongs to

configured_ios_sso
bool

True if the app has configured Single Sign On on iOS

contact_email
string

Email address listed for people using the app to contact developers

context

Social context for the app

created_time
datetime

Timestamp that indicates when the app was created

creator_uid
id

User ID of the creator of this app

daily_active_users
numeric string

The number of daily active users the app has

daily_active_users_rank
unsigned int32

Ranking of this app vs other apps comparing daily active users

deauth_callback_url
string

URL that is pinged whenever a person removes the app

default_share_mode
string

The platform that should be used to share content

description
string

The description of the app, as provided by the developer

financial_id
string

The ID for the corresponding audience network financial entity.

hosting_url
string

Webspace created with one of our hosting partners for this app

icon_url
string

The URL of this app's icon

ios_bundle_id
list<string>

Bundle ID of the associated iOS app

ios_supports_native_proxy_auth_flow
bool

Whether to support the native proxy login flow

ios_supports_system_auth
bool

Whether to support the iOS integrated Login Dialog

ipad_app_store_id
string

ID of the app in the iPad App Store

iphone_app_store_id
string

ID of the app in the iPhone App Store

is_viewer_admin
bool

Test if viewer is one of admins of this app

latest_sdk_version
ApplicationSDKInfo

App latest sdk version

link
string

A link to the app on Facebook

logging_token
string

To use for logging purposes

logo_url
string

The URL of the app's logo

migrations
map<string, bool>

Status of migrations for this app

mobile_profile_section_url
string

Mobile URL of the app section on a person's profile

mobile_web_url
string

URL to which Mobile users will be directed when using the app

monthly_active_users
numeric string

The number of monthly active users the app has

monthly_active_users_rank
unsigned int32

Ranking of this app vs other apps comparing monthly active users

name
string

The name of the app

namespace
string

The string appended to apps.facebook.com/ to navigate to the app's canvas page

object_store_urls

Mobile store URLs for the app

page_tab_default_name
string

The title of the app when used in a Page Tab

page_tab_url
string

The non-secure URL from which Page Tab app content is loaded

photo_url
string

The URL of the app photo

privacy_policy_url
string

The URL that links to a Privacy Policy for the app

profile_section_url
string

URL of the app section on a user's profile for the desktop site

restrictions

Demographic restrictions for the app

secure_canvas_url
string

The secure URL from which Canvas app content is loaded

secure_page_tab_url
string

The secure URL from which Page Tab app content is loaded

server_ip_whitelist
string

App requests must originate from this comma-separated list of IP addresses

social_discovery
unsigned int32

Indicates whether app usage stories show up in the Ticker or News Feed

subcategory
string

The subcategory the app can be found under

supported_platforms
list<enum {WEB, CANVAS, MOBILE_WEB, IPHONE, IPAD, ANDROID, WINDOWS, AMAZON, SUPPLEMENTARY_IMAGES, GAMEROOM, INSTANT_GAME}>

All the platform the app supports

terms_of_service_url
string

URL to Terms of Service that appears in the Login Dialog

url_scheme_suffix
string

URL scheme suffix

user_support_email
string

Main contact email for this app where people can receive support

user_support_url
string

URL shown in the Canvas footer that people can visit to get support for the app

website_url
string

URL of a website that integrates with this app

weekly_active_users
numeric string

The number of weekly active users the app has

Edges

EdgeDescription

accounts

Test User accounts associated with the app

achievements

The full list of Games achievement types that have been registered by this app.

ads_app_insights_dimensions

Insights dimensions data for this ads app

agencies

The businesses which are not owner but can advertise for this app

app_event_types

Info about App Events logged for the app

app_insights

Insights data for this app

appassets

appassets

audiences

Mobile custom audience sources by this app

authorized_adaccounts

The ad accounts which are authorized to advertise for this app

banned

List of people banned from this app

connections

List of Open Graph Action types associated with this app

custom_audience_third_party_id

Custom audience third party ID

da_checks

A list of results after running Dynamic Ads checks on this app.

direct_deals

Direct deals with advertisers for this publisher app

events

Events

food_drink_orders

food_drink_orders

insights_event_labels

Insights Event Labels for this app

local_service_booking_config

local_service_booking_config

moods_for_application

moods for application

object_types

Open Graph Object types associated with this app

objects

Open Graph objects

ozone_release

The app releases related to this app

payments_test_users

The list of payment test users for the app

permissions

The status of permissions that are have been submitted for Login Review

picture

An app's profile picture.

products

In-app-purchaseable products associated with this app

purchases

In-app-purchaseable products of this app owned by the user

roles

The developer roles defined for a Facebook app.

subscribed_domains

subscribed domains

insights

This object represents a single Insights metric that is tied to another particular Graph API object (Page, App, Post, etc.).

scores

Scores from this Facebook game for a user and their friends.

subscriptions

The Webhooks objects that this app has subscribed to.

translations

The strings from this app that were translated using our translations tools.

Validation Rules

ErrorDescription
100Invalid parameter
200Permissions error
190Invalid OAuth 2.0 Access Token
3000Reading Insights of a Page/App/Domain/Event Source Group not owned by the querying user or application
278Reading advertisements requires an access token with the extended permission ads_read
159Invalid protocol, must be https
3001Invalid query

Creating

You can make a POST request to activities edge from the following paths:
When posting to this edge, an Application will be created.

Parameters

NameDescription
advertiser_id
string

Apple's Advertising Identifier (IDFA) or Google Android's advertising ID. You can see how Facebook fetches this on iOS or on Android

advertiser_tracking_enabled
boolean

A person can choose to enable ad tracking on iOS 6+, and that choice is stored within the phone. You should fetch that and return it to Facebook so we know not to use the data for optimization. We will, however, use the data to report on a conversion. See here for an example of how Facebook fetches that variable. For devices running less than iOS 6, this query parameter can default to 1. Use 0 for disabled, 1 for enabled

anon_id
string

The ID of a person who has installed the app anonymously

app_user_id
string

Specifies user id of an app user. Used internally by the iOS and Android SDKs for MOBILE_APP_INSTALL event

application_tracking_enabled
boolean

A person can choose to enable ad tracking on an app level. Your SDK should allow an app developer to put an opt-out setting into their app. Use this field to specify the person's choice. Use 0 for disabled, 1 for enabled

attribution
string

mobile_cookie from the person's device. Use this only on Android or iOS devices before iOS 6. The format for this should look something like DDDECD0A-C076-4050-8CE8-C20EC3FC2BD3

auto_publish
boolean

This field is not longer being used. Used to be used internally by Facebook's SDK

bundle_id
string

Used internally by Facebook's SDK

bundle_short_version
string

Used internally by Facebook's SDK

bundle_version
string

Used internally by Facebook's SDK

consider_views
boolean

Specifies that view through data should be considered when determining the ad to attribute this install to. Clicks will always be considered first before views and views will only be returned if there was not a click on an ad for the app

custom_events
list<CustomEvent>

Custom events reported, required with CUSTOM_APP_EVENTS events. Please see our App Events API, App Events for iOS and App Events for Android for more information

_eventName
RegexParam

Name of the App Event

Required
_eventName_md5
RegexParam

MD5 hash of the event name

_valueToSum
float

Values to Sum

_logTime
int64

Time to Log

_implicitlyLogged
int64

Whether this is implicitly logged

_isTimedEvent
boolean

Whether this is a timed event

_session_id
string
_app_user_id
string
custom_events_file
file

Custom file, encoded as JSON that describes the event. Please encode as UTF-8 and attach with the mime type application/json or content/unknown

event
enum {MOBILE_APP_INSTALL, CUSTOM_APP_EVENTS, DEFERRED_APP_LINK}

Event type, one of MOBILE_APP_INSTALL, CUSTOM_APP_EVENTS or DEFERRED_APP_LINK. If you are reporting a MOBILE_APP_INSTALL event, you must include either attribution or advertiser_id in the request

Required
extinfo
Object

Extended device and source information array, used by Facebook's SDKs, MMPs and Bots for Messenger. This parameter is an array and must be in a specific format. Please see our App Events API for more information

0
string

extinfo version

Required
1
string

app package name

2
string

short version (int or string)

3
string

long version

4
string

OS version

5
string

device model name

6
string

locale

7
string

timezone abbreviation

8
string

carrier

9
int64

screen width

10
int64

screen height

11
string

screen density (float decimal , or .)

12
int64

CPU cores

13
int64

external storage size in GB

14
int64

free space on external storage in GB

15
string

device timezone

installer_package
string

Used internally by the Android SDKs

migration_bundle
string

Used internally by the iOS and Android SDKs

page_id
int64

Specifies the Page ID associated with the messenger bot that logs the event

page_scoped_user_id
int64

Specifies the page scoped User ID associated with the messenger bot that logs the event

ud
JSON object

Optional user data parameters for advanced matchingProvide hashed fields as key/value pairs similar to the Pixel

em
string

em

fn
string

fn

ln
string

ln

ph
string

ph

ge
string

ge

dob
string

dob

ct
string

ct

st
string

st

zp
string

zp

extern_id
string

extern_id

extern_namespace
string

extern_namespace

url_schemes
list<string>

Used internally by the iOS and Android SDKs

Return Type

Struct {
success: bool,
} Or Struct {
applink_class: string,
applink_url: string,
applink_args: string,
is_fb: bool,
is_paid: bool,
account_id: numeric string,
ad_id: numeric string,
ad_objective_name: string,
adgroup_id: numeric string,
adgroup_name: string,
campaign_id: numeric string,
campaign_name: string,
campaign_group_id: numeric string,
campaign_group_name: string,
click_time: timestamp,
is_mobile_data_terms_signed: bool,
is_external: bool,
is_instagram: bool,
is_view_through: bool,
view_time: timestamp,
}
You can make a POST request to mmp_auditing edge from the following paths:
When posting to this edge, an Application will be created.

Parameters

NameDescription
advertiser_id
string

Apple's Advertising Identifier (IDFA) or Google Android's advertising ID. You can see how Facebook fetches this on iOS or on Android

attribution
string

mobile_cookie from the person's device. Use this only on Android or iOS devices before iOS 6. The format for this should look something like DDDECD0A-C076-4050-8CE8-C20EC3FC2BD3

attribution_model
string

attribution model that clients selected to be respected by MMP

auditing_token
string

Token provided in cliam response sent to MMP

click_attr_window
int64

Time window of click attribution

decline_reason
string

Reason that MMP rejected Facebook ads claim

event
string

Event type that Facebook claimed for

Required
event_reported_time
int64

Time that event reported to MMP

fb_ad_id
int64

FBID of the ads in Facebook claim

Required
fb_click_time
int64

Ad click time in Facebook claim

fb_view_time
int64

Ad view time in Facebook claim

is_fb
boolean

Result that whether MMP attribute the event to Facebook ads

Required
view_attr_window
int64

Time window of view attribution

Return Type

Struct {
success: bool,
} Or Struct {
success: bool,
}
You can make a POST request to apps edge from the following paths:
When posting to this edge, an Application will be created.

Parameters

NameDescription
access_type
enum {OWNER, AGENCY}

access type

Required
app_id

app id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
access_status: string,
}
You can make a POST request to owned_apps edge from the following paths:
When posting to this edge, an Application will be created.

Parameters

NameDescription
app_id

app id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
access_status: string,
}
You can make a POST request to client_apps edge from the following paths:
When posting to this edge, an Application will be created.

Parameters

NameDescription
app_id

app id

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
access_status: string,
}
You can make a POST request to codeless_event_mappings edge from the following paths:
When posting to this edge, an Application will be created.

Parameters

NameDescription
mappings
array<JSON object>

The event to UI component mappings of the app

Required
mutation_method
enum {REPLACE, ADD, DELETE}

Detailed mutaiton type like replace, add

Required
platform
enum {ANDROID, IOS}

The platform of the app being indexed

Required

Return Type

Struct {
num_updated: int32,
num_invalid: int32,
}
You may perform a POST request to the following edges from this node:

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can update an Application by making a POST request to /{application_id}.

Parameters

NameDescription
an_platforms
list<enum {IOS, ANDROID, MOBILE_WEB, DESKTOP, INSTANT_ARTICLES, UNKNOWN}>

The platforms associated with the app in the AudienceNetwork product

android_class_name
string

The Main Activity you want Facebook to launch

android_key_hashes
list<string>

android key hashes

android_package_name
string

Unique app identifier used to open your app

android_sso
boolean

Will launch from Android Notifications

app_domains
list<string>

Specifies a list of domains that correspond to this app. Subdomains of domains in this array are also considered to belong to this app

app_name
string

App name

app_type
boolean

App type

auth_dialog_data_help_url
URL

The URL of a special landing page that helps users begin publishing Open Graph activity

auth_dialog_headline
string

One line description of this app that appears in the Login Dialog

auth_dialog_perms_explanation
string

The text to explain why an app needs additional permissions. This appears in the Login Dialog

auth_referral_default_activity_privacy
string

The default privacy setting selected for Open Graph activities in the Auth Dialog

auth_referral_enabled
boolean

Enables or disables Authenticated Referrals

auth_referral_extended_perms
list<string>

Extended permissions that a person can choose to grant when Authenticated Referrals are enabled

auth_referral_friend_perms
list<string>

Basic friends permissions that a person must grant when Authenticated Referrals are enabled

auth_referral_response_type
string

The format of the authentication token this app receives from the Login Dialog

auth_referral_user_perms
list<string>

Basic permissions that a person must grant when Authenticated Referrals are enabled

canvas_fluid_height
boolean

Indicates whether this app uses fluid or settable height values for Canvas

canvas_fluid_width
boolean

Indicates whether this app uses fluid or fixed width values for Canvas

canvas_url
URL

The non-secure URL from which Canvas app content is loaded

configured_ios_sso
boolean

Enables or disables SSO on iOS for this app

contact_email
string

Email address users can use to contact developers

created_time
time

Timestamp that indicates when this app was created

deauth_callback_url
URL

URL that is pinged whenever a person removes this app

ipad_app_store_id
string

ID of this app in the iPad App Store

iphone_app_store_id
string

ID of this app in the iPhone App Store

migrations
JSON-encoded string

Update the status of each platform migration

mobile_web_url
URL

URL that mobile users will be directed to when using this app

namespace
string

The string appended to apps.facebook.com/ to navigate to this app's Canvas page

page_tab_default_name
string

The title of this app as it appears in a Page Tab

page_tab_url
URL

The non-secure URL from which Page Tab app content is loaded

privacy_policy_url
URL

The URL that links to a privacy policy for this app

restrictions
JSON-encoded string

Update demographic restrictions for this app

secure_canvas_url
URL

The secure URL from which Canvas app content is loaded

secure_page_tab_url
URL

The secure URL from which Page Tab app content is loaded

server_ip_whitelist
list<string>

App requests must originate from this comma-separated list of IP addresses

social_discovery
boolean

Indicates whether app stories show up in ticker or News Feed

subcategory
string

The subcategory this app can be found under

terms_of_service_url
URL

URL to Terms of Service that appears in the Login Dialog

user_support_email
string

Main contact email for this app where people can receive support

user_support_url
URL

URL shown in the Canvas footer that people can visit to get support for this app

website_url
URL

URL of a website that integrates with this app

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
You can update an Application by making a POST request to /{application_id}/FoodDrinkOrders.

Parameters

NameDescription
order_id
string

Order id

Required
status
enum {CREATED, CONFIRMED, CANCELLED, DELIVERED, READY_FOR_PICKUP, OUT_FOR_DELIVERY}

Order status

Required

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Deleting

You can dissociate an Application from a Page by making a DELETE request to /{page_id}/subscribed_apps.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
messaging_success: bool,
}
You may perform a DELETE request to the following edge from this node:

Validation Rules

ErrorDescription
100Invalid parameter