Marketing API Version

Ad Rule History

Reading

The execution history associated with this rule. Each entry represents a distinct run of the rule and provides any actions that may have been taken on any ad objects.

Example

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

Parameters

NameDescription
action
enum{BUDGET_NOT_REDISTRIBUTED, CHANGED_BID, CHANGED_BUDGET, EMAIL, ENDPOINT_PINGED, ERROR, FACEBOOK_NOTIFICATION_SENT, MESSAGE_SENT, NOT_CHANGED, PAUSED, UNPAUSED}

Specify an action to only see results for objects that have that action performed on it for a given entry. Any other actions that apply to the resulting list of objects will still be returned.

hide_no_changes
boolean

Set this to true to hide all entries with either no results, or have all results with action NOT_CHANGED. This can be used in conjunction with other params.

object_id
numeric string or integer

Specify an object id to only see results for that object. If results is empty for an entry, this object did not pass evaluation.

Fields

Reading from this edge will return a JSON formatted result:

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

data

A list of AdRuleHistory nodes.

paging

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

Validation Rules

ErrorDescription
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.