Graph API Version

Product Event Stat

Reading

Stats on pixel fires and app events from sources associated with this catalog.

Each result object contains the count of matched and unmatched content ids and the count of matched and unmatched unique content ids for each day in the requested period of time. All results are automatically broken down by DA events (ViewContent, AddToCart and Purchase) and source of the event (pixel or app).

Example

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

The start date for event stats results.

date_stop
string

The end date for event stats results.

device_type
enum {desktop, mobile_android_phone, mobile_android_tablet, mobile_ipad, mobile_iphone, mobile_ipod, mobile_phone, mobile_tablet, mobile_windows_phone, unknown}

The type of device on which the event occurred. If device_type is not specified as a breakdown, results will not be broken down by the type of device the event occurred on.

event
enum {ViewContent, AddToCart, Purchase, InitiateCheckout, Search, Lead, AddToWishlist, Subscribe}

The type of DA event. Results are automatically broken down by the type of event.

event_source
ExternalEventSource

The external event source (pixel or app) associated with the catalog for which the events were received.

total_content_ids_matched_other_catalogs
int32

The total number of content ids from all events received for the particular breakdown of event, source and device type, that matched to an item in another catalog associated to the pixel or .app that fired the event. This count is not de-duplicated across content ids.

total_matched_content_ids
int32

The total number of content ids from all events received for the particular breakdown of event, source and device type, that matched to an item in the catalog. This count is not de-duplicated across content ids.

total_unmatched_content_ids
int32

The total number of content ids from all events received for the particular breakdown of event, source and device type, that didn't match an item in the catalog. This count is not de-duplicated across content ids.

unique_content_ids_matched_other_catalogs
int32

The number of unique content ids from all events received for the particular breakdown of event, source and device type, that matched to an item in another catalog associated to the given pixel or app which fired the event.

unique_matched_content_ids
int32

The number of unique content ids from all events received for the particular breakdown of event, source and device type, that matched to an item in the catalog.

unique_unmatched_content_ids
int32

The number of unique content ids from all events received for the particular breakdown of event, source and device type, that didn't match an item in the catalog.

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.