Graph API Version

Ads Action Stats

Reading

A single action for a Statistics result. Some fields that are marked default are returned only if you specify a breakdown for them.

Example

Graph API Explorer
GET v4.0/...?fields={fieldname_of_type_AdsActionStats} 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(
    '...?fields={fieldname_of_type_AdsActionStats}',
    '{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(
    "...?fields={fieldname_of_type_AdsActionStats}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_AdsActionStats}",
    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:@"...?fields={fieldname_of_type_AdsActionStats}"
                                      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
1d_click
numeric string

Metric value of attribution window "1 day after clicking the ad"

1d_view
numeric string

Metric value of attribution window "1 day after viewing the ad"

28d_click
numeric string

Metric value of attribution window "28 days after clicking the ad"

28d_view
numeric string

Metric value of attribution window "28 days after viewing the ad"

7d_click
numeric string

Metric value of attribution window "7 days after clicking the ad"

7d_view
numeric string

Metric value of attribution window "7 days after viewing the ad"

action_canvas_component_name
string

Name of a component within a Canvas ad

action_carousel_card_id
string

The ID of the specific carousel card that people engaged with when they saw your ad.

action_carousel_card_name
string

The specific carousel card that people engaged with when they saw your ad. The cards are identified by their headlines.

action_destination
string

The destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for your conversion pixel or an app configured with the software development kit (SDK).

action_device
string

The device on which the conversion event you're tracking occurred. For example, "Desktop" if someone converted on a desktop computer. Supported values are:
Other
Desktop
iPhone
iPad
iPod
Android Smartphone
Android Tablet
Offline
N/A

action_reaction
string

The number of reactions on your ads or boosted posts. The reactions button on an ad allows people to share different reactions on its content: Like, Love, Haha, Wow, Sad or Angry.

action_target_id
string

The id of destination where people go after clicking on your ad. This could be your Facebook Page, an external URL for your conversion pixel or an app configured with the software development kit (SDK).

action_type
string

The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Action types include Page likes, app installs, conversions, event responses and more.
Actions prepended by app_custom_event come from mobile app events and actions prepended by offsite_conversion come from the Facebook Pixel.
app_custom_event.fb_mobile_achievement_unlocked: Mobile App Feature Unlocks
app_custom_event.fb_mobile_activate_app: Mobile App Starts
app_custom_event.fb_mobile_add_payment_info: Mobile App Payment Details
app_custom_event.fb_mobile_add_to_cart: Mobile App Adds To Cart
app_custom_event.fb_mobile_add_to_wishlist: Mobile App Adds to Wishlist
app_custom_event.fb_mobile_complete_registration: Mobile App Registrations
app_custom_event.fb_mobile_content_view: Mobile App Content Views
app_custom_event.fb_mobile_initiated_checkout: Mobile App Checkouts
app_custom_event.fb_mobile_level_achieved: Mobile App Achievements
app_custom_event.fb_mobile_purchase: Mobile App Purchases
app_custom_event.fb_mobile_rate: Mobile App Ratings
app_custom_event.fb_mobile_search: Mobile App Searchs
app_custom_event.fb_mobile_spent_credits: Mobile App Credit Spends
app_custom_event.fb_mobile_tutorial_completion: Mobile App Tutorial Completions
app_custom_event.other: Other Mobile App Actions
app_install: App Installs
app_use: App Uses
checkin: Check-ins
comment: Post Comments
credit_spent: Credit Spends
games.plays: Game Plays
landing_page_view: Landing Page Views
leadgen.other: Leads (Form)
like: Page Likes
link_click: Link Clicks
mobile_app_install: Mobile App Installs
offsite_conversion.custom.<custom_conv_id>: Custom Conversions defined by the advertiser
offsite_conversion.fb_pixel_add_payment_info: Adds Payment Info
offsite_conversion.fb_pixel_add_to_cart: Adds To Cart
offsite_conversion.fb_pixel_add_to_wishlist: Adds To Wishlist
offsite_conversion.fb_pixel_complete_registration: Completed Registration
offsite_conversion.fb_pixel_custom: Custom pixel events defined by the advertiser
offsite_conversion.fb_pixel_initiate_checkout: Initiates Checkout
offsite_conversion.fb_pixel_lead: Leads
offsite_conversion.fb_pixel_purchase: Purchases
offsite_conversion.fb_pixel_search: Searchs
offsite_conversion.fb_pixel_view_content: Views Content
onsite_conversion.flow_complete: On-Facebook Workflow Completions
onsite_conversion.messaging_block: Blocked Messaging Conversations
onsite_conversion.messaging_conversation_started_7d: Messaging Conversations Started
onsite_conversion.messaging_first_reply: New Messaging Conversations
onsite_conversion.post_save: Post Saves
onsite_conversion.purchase: On-Facebook Purchases
outbound_click: Outbound Clicks
photo_view: Page Photo Views
post: Post Shares
post_reaction: Post Reactions
rsvp: Event Responses
video_view: 3-Second Video Views

Grouped Action Types:
app_engagement
app_story
page_engagement
page_story
post_engagement
instagram_profile_engagement
post_story
offsite_conversion
onsite_conversion
app_custom_event
onsite_web_app_event
mobile_app_retention
mobile_app_roas
offsite_engagement
store_visit_with_dwell
add_to_cart
onsite_app_add_to_cart
onsite_web_add_to_cart
onsite_web_app_add_to_cart
complete_registration
purchase
onsite_app_purchase
onsite_web_purchase
onsite_web_app_purchase
search
view_content
onsite_app_view_content
onsite_web_view_content
onsite_web_app_view_content
initiate_checkout
add_payment_info
add_to_wishlist
lead
omni_app_install
omni_purchase
omni_add_to_cart
omni_complete_registration
omni_view_content
omni_search
omni_initiated_checkout
omni_achievement_unlocked
omni_activate_app
omni_level_achieved
omni_rate
omni_spend_credits
omni_tutorial_completion
omni_custom
subscribe

action_video_sound
string

The sound status (on/off) when someone plays your video ad.

action_video_type
string

Video metrics breakdown.

inline
numeric string

Metric value of attribution window that can occurs on the ad itself

value
numeric string

Metric value of default attribution window

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.