Effect

A generic effect that is fired by a triggered campaign. The props property will contain information specific to the specific effect type.

Properties

Name	Type	Description	Notes
campaign_id	int	The ID of the campaign that triggered this effect.
ruleset_id	int	The ID of the ruleset that was active in the campaign when this effect was triggered.
rule_index	int	The position of the rule that triggered this effect within the ruleset.
rule_name	str	The name of the rule that triggered this effect.
effect_type	str	The type of effect that was triggered. See API effects.
triggered_by_coupon	int	The ID of the coupon that was being evaluated when this effect was triggered.	[optional]
triggered_for_catalog_item	int	The ID of the catalog item that was being evaluated when this effect was triggered.	[optional]
condition_index	int	The index of the condition that was triggered.	[optional]
evaluation_group_id	int	The ID of the evaluation group. For more information, see Managing campaign evaluation.	[optional]
evaluation_group_mode	str	The evaluation mode of the evaluation group. For more information, see Managing campaign evaluation.	[optional]
campaign_revision_id	int	The revision ID of the campaign that was used when triggering the effect.	[optional]
campaign_revision_version_id	int	The revision version ID of the campaign that was used when triggering the effect.	[optional]
props	object	The properties of the effect. See API effects.