Skip to content

CampaignState

Source code in docs_src/capo_pinpoint/types/campaign_state.py 
11
12
13
class CampaignState(TypedDict, closed=True):
    campaign_status: NotRequired["capo_pinpoint.types.campaign_status.CampaignStatus"]
    """<p>The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.</p> <p>If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.</p>"""

campaign_status instance-attribute 

campaign_status: NotRequired[CampaignStatus]

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.