Graph API Version

Ad Account Ad Rules History

Reading

The history node provides rule execution results for the rule, as ordered by the time of rule execution. Each rule execution entry by default includes all results for which at least one ad object passed the evaluation phase.

Parameters

ParameterDescription
action
enum{BUDGET_NOT_REDISTRIBUTED, CHANGED_BID, CHANGED_BUDGET, EMAIL, ENDPOINT_PINGED, ERROR, FACEBOOK_NOTIFICATION_SENT, MESSAGE_SENT, NOT_CHANGED, PAUSED, UNPAUSED, ENABLE_AUTOFLOW, ENABLE_ADVANTAGE_PLUS_CREATIVE, ENABLE_SEMANTIC_BASED_AUDIENCE_EXPANSION, ENABLE_ADVANTAGE_PLUS_PLACEMENTS, ENABLE_ADVANTAGE_CAMPAIGN_BUDGET, ENABLE_GEN_UNCROP, ENABLE_MUSIC, ENABLE_SHOPS_ADS, CONVERT_ASC_CP_SINGLE_INSTANCE, CONSOLIDATE_ASC_FRAGMENTATION, CONSOLIDATE_FRAGMENTATION, ENABLE_REELS_PLACEMENTS, ENABLE_LANDING_PAGE_VIEWS, ENABLE_ADVANTAGE_PLUS_AUDIENCE, ENABLE_PRODUCT_SET_BOOSTING, ENABLE_SHOPS_ADS_SAOFF, ENABLE_PIXELLESS_LPV_OPTIMIZATION_GOAL, ENABLE_WTWA_UPSELL_IN_DUPLICATION}

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

FieldDescription
exception_code
int32

Exception code if encountered during this rule execution.

exception_message
string

Exception message if encountered during this rule execution.

is_manual
bool

Whether this execution was scheduled or manually performed via the /execute endpoint.

results
list<AdRuleHistoryResult>

List of results of this rule execution. If empty, this means that no ad objects passed evaluation.

rule_id
integer

Rule ID for the rule which was executed execution. This is provided for easier bookkeeping of rule editing changes.

schedule_spec

The schedule spec of this rule execution. This is provided for easier bookkeeping of rule editing changes.

timestamp
datetime

Timestamp of this rule execution.

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.