research

Get campaign settings (v3)

Deprecated: use research.campaign-settings.get.v4 (research_campaign_settings_get_v4), which also names a study's customer assumptions; this version leaves them out, so a study that states some reads as a version 4 study without them. Get a Research campaign's saved study, targeting and schedule, active, paused or archived alike: the study, its description, its questions and the file or video each shows, the interviews each quota period takes, whom they reach, the competitors it compares with, and its schedule as campaigns_summaries_get_v2 names it. Its progress and standing are campaigns_summaries_get_v2's.

get/api/v1/research/campaign-settings-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/campaign-settings-v3/{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 Research campaign 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 nullable required

The business profile it runs on.

subtype'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' | 'purchasing' | 'competitors' required

The study it runs.

targetKind'profile' | 'physical_locations' required

Whom it interviews: the profile's customers, or its stores' customers.

targetInterviewCountinteger required

The interviews each run takes.

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 interviews; null for current customers.

competitorSetstring[] required

The competitors it was set up to compare with.

settingsRevisioninteger required

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

Changes

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