research

List campaign customers (v4)

List a Research campaign's current customers a page at a time, newest first: every customer on its roster who is still active in its business profile, with their traits, audiences, and sources. query narrows by name or job title and groupIds to members of those audiences; selectedGroupIds also answers which of the matching customers belong to those audiences, across every page. Pass a customer's id as a { axis: customer, id } entry in segments to research_results_get_v7 or research_conversations_list_v2 to narrow them to that customer. A campaign your organization does not own is not found. Page with nextCursor at the same limit.

get/api/v1/research/campaign-customers-v4

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/campaign-customers-v4
  • 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)

Query parameters

limitinteger

Number of items to return (1–1000)

cursorstring

Opaque cursor returned as nextCursor by the previous page

campaignIdstring uuid required

The campaign id from research.campaigns.list.v1.

querystring
groupIdsstring[]
selectedGroupIdsstring[]
filtersstring[]

Field conditions, each <field>:<operator>:<value>. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and min..max. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), none for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and from..to, read in UTC.

filterMatch'all' | 'any'

Whether a customer matches every condition (all, the default) or any one

lifecycleStatus'active' | 'archived' | 'all'

active (default): the campaign's customers on its roster now; archived: the customers it has held who are archived since; all: both.

Headers

Point11-Organizationstring uuid

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

Response

Success.

nextCursorstring nullable required
totalCountinteger required
selectedCustomerIdsstring[] required
audienceTypesstring[] required

The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column.

Changes

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