experience

Get campaign settings

Get an Experience campaign's saved setup, active, paused or archived alike: its targets (starting pages, signed-in access, apps), devices, objective, customers, the Discovery campaign a Pulse mirrors, a campaign follows for its customers or reads its customers' direct competitors from, and customerVersions, which always answers latest: every new cycle uses each customer's newest version. Its schedule, progress and standing are campaigns_summaries_get_v2's.

get/api/v1/experience/campaign-settings/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/campaign-settings/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

The Experience campaign's id

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

idstring uuid required
businessProfileIdstring uuid required

The business profile it runs on.

mode'pulse' | 'burst' required

A Burst runs its own customers; a Pulse mirrors a Discovery campaign.

browserDevicesstring[] required

The devices a browser uses.

agentsstring[] required

The agents each next cycle shops with, every one on every customer, page and device; point11 is Point11's own shopper, every other agent runs its vendor's model in Point11's browser.

objectivestring nullable required

What each customer sets out to do.

targetedGroupIdsstring[] nullable required

The audiences it was targeted at; null when not narrowed to audiences.

targetedCustomerIdsstring[] nullable required

The customers it was picked from; null when not hand-picked.

targetedForecastIdstring uuid nullable required

The forecast whose customers it runs; null for current customers.

customerCountinteger required

The customers a Burst froze at launch.

customerIdsstring[] nullable required

An always-on Burst's customer list: the customers its next cycles visit. Null where a Save cannot change the customers: a one-time Burst, one still on the retired weekly or monthly schedule, or a Pulse.

sourceCampaignIdstring uuid nullable required

The Discovery campaign a Pulse mirrors.

sourceCampaignNamestring nullable required
competitorSourceCampaignIdstring uuid nullable required

The Discovery campaign, on the same business profile, whose conversations name each customer's direct competitors, which every cycle shops beside the pages; set at launch, never by a Save. Null when the campaign shops its pages alone, and on a Pulse.

competitorSourceCampaignNamestring nullable required
followedCampaignIdstring uuid nullable required

The Discovery campaign a Burst follows for its customers: each scheduled cycle it plans re-reads that campaign's roster, so a customer who left it leaves, each store the list no longer covers lends its share up to 100, and a Save changes no customers. Set at launch, never by a Save. Null when the campaign records no follow.

followedCampaignNamestring nullable required
followedCampaignStatus'active' | 'paused' | 'archived' | 'deleted' nullable required

The followed campaign's lifecycle. While it is archived the Burst keeps the customer list it last read, and a restore resumes the follow at the next scheduled cycle; once it is deleted the list stays for good.

pulseCompetitorsboolean nullable required

Whether a Pulse also shops the competitors Discovery showed each customer; null for a Burst.

pulseSampleEveryinteger nullable required

A Pulse mirrors 1 in this many of each source dispatch's Discovery conversations; 1 is every one. Null for a Burst.

settingsRevisioninteger required

Its settings revision: pass it as expectedSettingsRevision to experience.campaign-settings-quotes.get and experience.campaign-settings.update.

Changes

No recorded changes to this operation across all 1 revision of this API.