Marketing API Version

Custom Conversion Stats

Reading

Stats data for this conversion

Graph API Explorer
GET /v2.10/{custom-conversion-id}/stats HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{custom-conversion-id}/stats'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{custom-conversion-id}/stats",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{custom-conversion-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:@"/{custom-conversion-id}/stats"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Permissions

Developers usually request these permissions for this endpoint:

Marketing Apps
  • ads_management
  • ads_read
Page management Apps
No data
Other Apps
No data

Parameters

NameDescription
aggregation
enum{count, device_type, host, pixel_fire, unmatched_count, unmatched_usd_amount, url, usd_amount}

The aggregation to use for the stats.

device_type: Get the number of pixel fires per mobile device type, grouped by hour.
You can use this aggregation type with custom conversions from the event source pixel.

host: Get the number of pixel fires for the top 10,000 hosts grouped by hour.
You can use this aggregation type with custom conversions from the event source pixel.

url: Get the number of pixel fires for the top 10,000 URLs grouped by hour. Facebook pulls query parameters from the URLs.
You can use this aggregation type with custom conversions from the event source pixel.

pixel_fire: Get the number of pixel fires by hour (deprecated, please use count instead).

count: Get the number of event fires.
For pixel based custom conversion, the number is grouped by hour.
For offline_conversion_data_set based custom conversion, the number is grouped by day.
You can use this aggregation type with custom conversions from the event source pixel and offline_conversion_data_set .

unmatched_count: Number of event fires Facebook cannot match to user. Grouped by day.
You can use this aggregation type with custom conversions from the event source offline_conversion_data_set .

usd_amount: USD amount, in cents, for custom conversion grouped by day.
You can use this aggregation type with custom conversions from the event source offline_conversion_data_set .

unmatched_usd_amount: USD amount, in cents, for custom conversion that Facebook cannot match with users. Grouped by day.
You can use this aggregation type with custom conversions from the event source offline_conversion_data_set

end_time
datetime

End time of the requested stat

start_time
datetime

Start time of the requested stat

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of CustomConversionStatsResult 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

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.