Graph API Version

Business Adnetworkanalytics

Reading

Audience Network Insights for this publisher entity

Example

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

ParameterDescription
aggregation_period
enum {DAY, TOTAL}
Default value: "DAY"

The interval to aggregate by

breakdowns
array<enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION}>
Default value: []

Optional breakdowns for results

filters
array<JSON object>
Default value: []

Additional filters for the query

limit
int64
Default value: 2000

Limit the number of rows returned

metrics
array<enum {FB_AD_NETWORK_BIDDING_REQUEST, FB_AD_NETWORK_BIDDING_RESPONSE, FB_AD_NETWORK_BIDDING_BID_RATE, FB_AD_NETWORK_BIDDING_WIN_RATE, FB_AD_NETWORK_REQUEST, FB_AD_NETWORK_FILLED_REQUEST, FB_AD_NETWORK_FILL_RATE, FB_AD_NETWORK_IMP, FB_AD_NETWORK_IMPRESSION_RATE, FB_AD_NETWORK_CLICK, FB_AD_NETWORK_CTR, FB_AD_NETWORK_BIDDING_REVENUE, FB_AD_NETWORK_REVENUE, FB_AD_NETWORK_CPM, FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE, FB_AD_NETWORK_VIDEO_VIEW, FB_AD_NETWORK_VIDEO_VIEW_RATE, FB_AD_NETWORK_VIDEO_MRC, FB_AD_NETWORK_VIDEO_MRC_RATE, FB_AD_NETWORK_SHOW_RATE}>

List of metrics to query for

Required
ordering_column
enum {TIME, VALUE, METRIC}
Default value: "TIME"

Order results by value (result of the aggregation) or by time.

ordering_type
enum {ASCENDING, DESCENDING}
Default value: "DESCENDING"

Ascending or descending

since
datetime/timestamp

A unix timestamp or strtotime data value that indicates the start of the data range

until
datetime/timestamp

A unix timestamp or strtotime data value that indicates the end of the data range

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of AdNetworkAnalyticsSyncQueryResult nodes.

paging

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

Validation Rules

ErrorDescription
3000Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application
100Invalid parameter
200Permissions error
3010Invalid breakdown

Creating

You can make a POST request to adnetworkanalytics edge from the following paths:
When posting to this edge, an AnalyticsQueryResult will be created.

Parameters

ParameterDescription
aggregation_period
enum {DAY, TOTAL}
Default value: DAY

The interval to aggregate by

breakdowns
list<enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION}>
Default value: Vec

Optional breakdowns for results

filters
list<Object>
Default value: Vec

Additional filters for the query

field
enum {AGE, APP, COUNTRY, DELIVERY_METHOD, DISPLAY_FORMAT, DEAL, DEAL_AD, DEAL_PAGE, GENDER, PLACEMENT, PLACEMENT_NAME, PLATFORM, PROPERTY, CLICKED_VIEW_TAG, FAIL_REASON, SDK_VERSION}

Field on which filter is applied. Currently, only valid breakdowns are supported in filters. eg. Country, OS, etc.

Required
operator
enum {IN, NOT_IN}

The intended operation between field and values. eg. IN, etc.

Required
values
list<string>
Default value: Vec

Values of corresponding field which must be filtered in result subject to the operator. The results join the different field valuesdisjunctively. eg. For Filters = {"Country", "IN", ["US", UK]} translates to {"Country", "IN", "US"} OR {"Country", "IN", "UK"}

limit
integer
Default value: 20000

Limit the number of rows returned

metrics
list<enum {FB_AD_NETWORK_BIDDING_REQUEST, FB_AD_NETWORK_BIDDING_RESPONSE, FB_AD_NETWORK_BIDDING_BID_RATE, FB_AD_NETWORK_BIDDING_WIN_RATE, FB_AD_NETWORK_REQUEST, FB_AD_NETWORK_FILLED_REQUEST, FB_AD_NETWORK_FILL_RATE, FB_AD_NETWORK_IMP, FB_AD_NETWORK_IMPRESSION_RATE, FB_AD_NETWORK_CLICK, FB_AD_NETWORK_CTR, FB_AD_NETWORK_BIDDING_REVENUE, FB_AD_NETWORK_REVENUE, FB_AD_NETWORK_CPM, FB_AD_NETWORK_VIDEO_GUARANTEE_REVENUE, FB_AD_NETWORK_VIDEO_VIEW, FB_AD_NETWORK_VIDEO_VIEW_RATE, FB_AD_NETWORK_VIDEO_MRC, FB_AD_NETWORK_VIDEO_MRC_RATE, FB_AD_NETWORK_SHOW_RATE}>

Metrics to return

Required
ordering_column
enum {TIME, VALUE, METRIC}
Default value: TIME

Order results by value (result of the aggregation) or by time.

ordering_type
enum {ASCENDING, DESCENDING}
Default value: DESCENDING

Ascending or descending

since
datetime/timestamp

A unix timestamp or strtotime data value that indicates the start of the data range

until
datetime/timestamp

A unix timestamp or strtotime data value that indicates the end of the data range

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
query_id: string,
async_result_link: string,
}

Validation Rules

ErrorDescription
3000Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.