Marketing API Version

Ads Pixel Stats

Reading

Stats data for this pixel

Example

Graph API Explorer
GET /v3.0/{ads-pixel-id}/stats 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(
    '/{ads-pixel-id}/stats',
    '{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(
    "/{ads-pixel-id}/stats",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{ads-pixel-id}/stats",
    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:@"/{ads-pixel-id}/stats"
                                      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

NameDescription
aggregation
enum{browser_type, custom_data_field, device_os, device_type, event, host, pixel_fire, url, event_total_counts}

The aggregation to use for the stats.
browser_type: Get the number of pixel fires per browser type, broken down by hour.
custom_data_field: Get the number of pixel fires for the top 100 custom data fields of an event broken down by hour.
device_os: Get the number of pixel fires per mobile device OS, broken down by hour.
device_type: Get the number of pixel fires per mobile device type, broken down by hour.
event: Get the number of pixel fires for the top 100 events broken down by hour.
host: Get the number of pixel fires for the top 10,000 hosts broken down by hour.
url: Get the number of pixel fires for the top 10,000 URLs broken down by hour. Please note that query parameters are stripped from the URLs.
pii_keys: Get the number of pixel fires by PII keys by hour.
pii_lift: Get the number of pixel fires matched by PII by hour.
pixel_fire: Get the number of pixel fires by hour.
event_total_counts: Get the number of pixel fires for all events over the entire time span.

end_time
datetime/timestamp
Default value: 1529349054

The end time of the stats, in the format of Unix or ISO 8601 timestamp. You can get the data up to seven days from the request time.

event
string

Specify which event to aggregate on, when the aggregation is custom_data_field

start_time
datetime/timestamp

The start time of the stats, in the format of Unix or ISO 8601 timestamp.

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of AdsPixelStatsResult nodes.

paging

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

Validation Rules

ErrorDescription
100Invalid parameter
294Managing advertisements requires an access token with the extended permission for ads_management
275Cannot determine the target object for this request. Currently supported objects include ad account, business account and associated objects.
200Permissions error
270This Ads API request is not allowed for apps with development access level (Development access is by default for all apps, please request for upgrade). Make sure that the access token belongs to a user that is both admin of the app and admin of the ad account
272This Ads API call requires the user to be admin of the application
278Reading advertisements requires an access token with the extended permission ads_read
274The ad account is not enabled for usage in Ads API. Please add it in developers.facebook.com/apps -> select your app -> settings -> advanced -> advertising accounts -> Ads API
273This Ads API call requires the user to be admin of the ad account

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.