Graph API
Graph API Version

Application Activities

Application activities are events from your app.

Reading

You can't perform this operation on this endpoint.

Creating

You can use a user access token or app access token to log events to this endpoint.

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

Parameters

ParameterDescription
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

Specifies whether a person has enabled advertising tracking on their iOS 14.5+ device. Set to 0 for disabled or 1 for enabled. You should fetch this data and return it to Meta will use the event data (from partners about user activities off Meta) pursuant to its Data Policy, including for ad reporting, fraud detection and to build and improve our products (including our ads delivery products), but will restrict use of data about that individual to personalize that user’s ads. For devices running earlier versions than iOS 6, this parameter should default to 1.

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

attribution_referrer
string

attribution_referrer

attribution_sources
array<JSON object>

For post-install events credited to Meta, attribution_sources contains information about the earlier claim Meta made (typically for an install event) that drove the attribution for this event.

source_ad_id
int64

source_ad_id

source_ad_engagement_time
datetime/timestamp

source_ad_engagement_time

source_ad_engagement_type
string

source_ad_engagement_type

source_event_time
datetime/timestamp

source_event_time

source_event_id
string

source_event_id

source_install_id
string

source_install_id

source_auditing_token
string

source_auditing_token

source_attribution_method
string

source_attribution_method

source_is_primary
boolean

source_is_primary

source_adgroup_id
int64

source_adgroup_id

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

campaign_ids
string

Parameter passed via the deep link for Mobile App Engagement campaigns.

click_id
string

click_id

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

Event name, must match the regular expression /^[0-9a-zA-Z_][0-9a-zA-Z _-]{0,39}$/

Required
_eventName_md5
RegexParam

MD5 hash of the event name, must match the regular expression /^[A-Fa-f0-9]{32}$/

_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

device_token
string

A token used to identify the device on push networks

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
event_id
string

event_id is used for MMP to cross-validate the campaign claim response with Meta.

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

google_install_referrer
string

google_install_referrer

include_dwell_data
boolean

Specifies that view dwell ms should be returned as part of view through data

include_video_data
boolean

Specifies that video view completion percentages should be returned as part of view through data

install_id
string

If this is an install event, install_id should be an MMP-generated ID unique across all installs (which can be the same as the event_id). If this is a post-install event, the install_id should be MMP-defined install_id of the install event that preceded this event.

install_referrer
string

3rd party install referrer, currently available for Android only, see https://developers.google.com/analytics/devguides/collection/android/v4/campaigns

install_timestamp
float

The timestamp of the app install or app event

installer_package
string

Used internally by the Android SDKs

is_fb
boolean

Include this field for post-install events when the attribution result is already available.

meta_install_referrer
string

meta_install_referrer

migration_bundle
string

Used internally by the iOS and Android SDKs

operational_parameters
array<JSON object>

An array of operational parameters where each index corresponds to the event in custom_events array. These are operational parameters that are not set by the advertiser, but instead only used for operational and debugging purposes. For each index, operational parameters are segmented into different use cases.

iap_parameters
AppOperationalData

iap_parameters

deferral_link_parameters
AppOperationalData

deferral_link_parameters

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

receipt_data
string

The receipts of in-app purchase

sdk_version
string

sdk_version

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

db
string

db

r1
string

r1

r2
string

r2

cn
string

cn

r3
string

r3

r4
string

r4

r5
string

r5

r6
string

r6

r7
string

r7

r8
string

r8

country
string

country

external_id
string

external_id

url_schemes
array<string>

Used internally by the iOS and Android SDKs

user_id
string

user_id

user_id_type
enum {INSTANT_GAMES_PLAYER_ID}

user_id_type

vendor_id
string

vendor_id

windows_attribution_id
string

Attribution token used for Windows 10

Return Type

Struct {
success: bool,
} Or Struct {
applink_class: string,
applink_url: string,
applink_args: string,
is_fb: bool,
is_paid: bool,
account_id: ad account id,
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,
is_modeled: bool,
is_same_ip: bool,
device_model: string,
os_version: string,
view_time: timestamp,
is_playable_ad: bool,
is_aaa_campaign: bool,
creative_id: numeric string,
engagement_type: enum,
trace_id: string,
fbclid: string,
event_id: string,
vertical: string,
sub_vertical: string,
advertiser_region: string,
} Or Struct {
success: bool,
drop_reason: string,
}

Error Codes

ErrorDescription
200Permissions error
190Invalid OAuth 2.0 Access Token
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.