research

Launch campaigns

Start a Research study on a business profile's customers, once or on a weekly or monthly quota, for an organization already subscribed to Point11 Analytics. Returns the campaign and the billing run of its first interviews; an organization without an active subscription is refused, since subscribing happens only in the dashboard. Every interview is billed as delivered usage against the organization's allowance, then approved overage; a weekly or monthly study consumes allowance on every run.

post/api/v1/research/campaigns/launch

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/campaigns/launch
  • 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

campaignNamestring required
descriptionstring

The study's description, shown under its name on the results; display only, never asked of respondents.

businessProfileIdstring uuid required

The business profile whose customers the study interviews.

targetKind'profile' | 'physical_locations'

The profile's own customers (default), or every customer generated for its current store overlays.

targetedGroupIdsstring[] nullable required

Saved audiences to interview, or null for the whole cohort.

targetedCustomerIdsstring[] nullable required

Explicit customers to interview, or null. Never together with saved audiences.

targetInterviewCountinteger required
researchFocusstring required

The study's research focus, screened whole by acceptable use: at most 2,000 characters.

schedule'once' | 'weekly' | 'monthly' required
playbookKey'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' required
kind'backtest'

backtest when the study re-asks a decision the business already made: its situation is the shared material every twin reads first, and its results compare with the outcome recorded on its Overview. Omit it for any other study.

assumptionsstring[]

Customer assumptions: statements every respondent answers as true of themselves for this study only, beside their own profile, in order; absent or empty when the study states none. Acceptable use screens each whole, so each is at most 2,000 characters, and none is empty.

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

runIdstring uuid required

The billing run of the campaign's first interviews.

entryIdstring required

The campaign entry this request started; read its progress with campaigns.campaign-entries.get.v1.

status'workflow_started' | 'encounter_coordination_required' required

How the first run starts.

campaignIdstring uuid required
study'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' required

Changes

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