experience

Prescreen campaigns (v2)

Screen a complete Burst while the customer is still reviewing it, with the input experience_campaigns_start_v4 takes and mode burst. Commits, funds, and dispatches nothing. The same idempotency key reaches the same screening attempt, so a later start with that key and an unchanged grid answers from it instead of screening again. A launch that follows a Discovery campaign also learns how many of its customers it would shop (followedCustomerCount) and at how many of its stores (followedStoreCount); it refuses as the start would when that campaign cannot be followed. A launch that names stores likewise learns how many customers at them it would shop (locationCustomerCount) and at how many of them (locationStoreCount), and refuses as the start would when a store is not the profile's, none of their customers can visit, or its new stores would generate more customers than one Discovery settings Save may; when stores it picked on Google Maps have no customers yet, it also learns the one-time generation their setup needs and what it costs (customerGeneration).

post/api/v1/experience/campaigns/prescreen-v2

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/campaigns/prescreen-v2
  • 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)

Headers

Point11-Organizationstring uuid

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

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

mode'burst' required
campaignNamestring required
browserDevicesstring[]

The devices every customer shops each page on, each once; each device's visit is one experience run. Absent, desktop and mobile. A nativeApp names mobile alone.

agentsstring[]

The agents that shop every customer on every page and device, each once (1 to 5). point11 is Point11's own shopper; dots (OpenAI Dots), spark (Gemini Spark), muse (Meta Muse) and grok_bot (Grok Bot) each run the model that vendor's agent most likely uses, in Point11's browser, never as the real agent. Each agent's visit is one experience run at the same price. Absent, point11 alone. A settings Save changes them from the next cycle.

businessProfileIdstring uuid required
customerIdsstring[]

The customers who visit: at least one, and as many as the launch's 1,000 visits hold (each customer visits every page on every device with every agent). Not with follows or stores (locationKeys, locationContexts), which choose them.

locationKeysstring[]

Instead of customerIds or follows, the business profile's stores whose customers visit (1 to 100): each a location key business_store_profile_summaries_get_v1 lists under businessProfileId; a key that is not one of its stores now is refused. At the launch, every customer at them the launch admits, dealt one per store in the profile's store order until 100, as a followed local Discovery campaign's share is at 1 in 1. They are chosen once and become the campaign's customers; nothing of the stores is recorded.

destinationUrlsstring[] required
objectivestring required
competitorSourceCampaignIdstring uuid

A Discovery campaign on the same business profile (discovery_campaigns_list_v1's businessProfileId). Each run, every customer also shops every brand its latest settled conversation there labelled a direct competitor; a customer with none shops the pages alone. Set at launch, never changed. Public websites only: not with connectionAccess or nativeApp.

Response

Success.

outcome'allowed' required
followedCustomerCountinteger nullable required

How many of the followed Discovery campaign's customers the launch would shop now, its share; Start chooses them again. Null unless the launch follows a Discovery campaign.

followedStoreCountinteger nullable required

How many of the followed Discovery campaign's stores the share's customers are at; 0 for a campaign that measures no stores. Null unless the launch follows a Discovery campaign.

locationCustomerCountinteger nullable required

How many customers at the stores locationKeys and locationContexts name the launch would shop, its share of at most 100, the customers its new stores' setup generates included; Start chooses them again. Null unless the launch names stores.

locationStoreCountinteger nullable required

How many of the stores locationKeys and locationContexts name the share's customers are at, its new stores included. Null unless the launch names stores.

Changes

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