research

Get campaign settings quotes

Review a Save of a Research campaign's settings before making it, writing nothing: each change and when it starts (from the next admission day), the change in estimated monthly interviews at today's price, Billing's answer to the extra work and how the change reaches results (an edited question starts fresh from its first answer after the change; every unchanged question keeps its history). Pass the settingsRevision research_campaign_settings_get_v4 returned as expectedSettingsRevision; refused when the settings changed since. id is the campaign's id.

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

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/campaign-settings-quotes/{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's id.

Query parameters

expectedSettingsRevisioninteger required

The settingsRevision the settings read (or a quote) returned.

namestring

The campaign's new name.

targetInterviewCountinteger

Interviews each period takes, one per customer: raising it adds the next eligible customers in the study's own sampling order, lowering it removes the newest joined first (named in the quote's customersLeaving) and cancels their interviews not yet started.

audience'all' | 'groups'

Whom customers added later are drawn from: every eligible customer (all) or members of targetedGroupIds (groups). The current customers stay.

targetedGroupIdsstring[]

The audiences, with audience groups.

frequency'weekly' | 'monthly'

The period a repeating study interviews each customer once in; a new period starts at the next admission day.

studyChangedboolean

Whether the Save changes the study; an edited question starts fresh in results.

Headers

Point11-Organizationstring uuid

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

Response

Success.

settingsRevisioninteger required

The settings revision this quote read; pass it as expectedSettingsRevision.

requiresReviewboolean required

Whether the Save changes money or results, so Billing is asked about its work and a quoted estimate is re-checked; false when it changes only the name.

resultsNotestring nullable required

How the change reaches results; null when results do not change.

Changes

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