Marketing API Version

Product Catalog Da Event Samples

Reading

Returns a list of top unmatched content_ids or top urls sending unmatched content_ids for the input event source. An unmatched content_id is one that did not match any catalog in the event fire. The results are aggregated over the last day and return upto a maximum of 200 samples ordered by unmatched count. This is useful to quickly identify and fix top URLs causing low catalog match rate.

  Both Pixel and App event source support content_id-based aggregation.
  Only Pixel source supports content_url-based
  aggregation. Each sample node contains date, chosen aggregation value
  (content_url or content_id), count of unmatched events, count of
  events matched to other catalog associated with the event source and
  count of events matched to products in the current catalog.

Example

Graph API Explorer
GET /v2.11/{product-catalog-id}/da_event_samples 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(
    '/{product-catalog-id}/da_event_samples',
    '{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(
    "/{product-catalog-id}/da_event_samples",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{product-catalog-id}/da_event_samples",
    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:@"/{product-catalog-id}/da_event_samples"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Parameters

NameDescription
aggregation_type
enum{CONTENT_ID, CONTENT_URL}

Chosen aggregation type: content_id or URL

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

Event name

Required
source_id
numeric string or integer

Pixel or App Events ID that sent the event data

Required

Fields

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {} }

data

A list of ProductDaEventSamplesBatch nodes.

paging

For more details about pagination, see the Graph API guide.

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter

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.