discovery

Get campaign settings

Get a Discovery campaign's saved setup, active, paused or archived alike: its assistants, precision, customer target and pool, audience or customer targeting, and store locations. Its schedule, progress and standing are campaigns_summaries_get_v2's.

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

Request

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

Discovery 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.

mode'current' | 'forecast' | 'both' required

Whether it samples current customers, forecast customers, or both.

enginesstring[] required

The assistants it asks.

marginOfErrornumber required

Its precision target: the margin of error, in percent.

targetCustomerCountinteger required

The customers it samples; it grows with the roster.

rosterCustomerCountinteger nullable required

The customers on the campaign now, whom its runs interview: its roster, less anyone removed. A named removal lowers it and leaves targetCustomerCount. Null until its first run has chosen them.

targetKind'profile' | 'physical_locations' nullable required

What it measures; null while a first campaign's setup has not settled it.

locationCountinteger required

How many stores it measures now.

locationCoverageMode'standard' | 'one_per_location' required

Whether every store location gets at least one customer (one_per_location).

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.

settingsRevisioninteger required

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

Changes

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