research

Get campaigns

Get one Research campaign by id, with how many distinct stores its active members are bound to (0 for a profile campaign).

get/api/v1/research/campaigns/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/campaigns/{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 campaign id from research.campaigns.list.v1.

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
campaignKeystring required

The campaign's route key.

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

The study the campaign runs.

status'active' | 'paused' | 'archived' | 'deleted' required
targetKind'profile' | 'physical_locations' required

The frozen cohort: the business profile's customers, or its physical stores.

businessProfileIdstring uuid nullable required
profileNamestring nullable required

The launch profile's display name, else the campaign URL; null without a profile.

createdAtstring date-time required
locationCountinteger required

A store campaign's distinct stores among its active members; 0 for a profile campaign.

Changes

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