discovery

List roster members (v3)

Deprecated: use discovery.roster-members.list.v4 (discovery_roster_members_list_v4), which names no faviconLightUrl or faviconDarkUrl: a favicon is one image for both themes, faviconUrl. This version answers the same and names both, never sent. List a Discovery campaign's customers (its roster): the current ones by default, or the removed ones, or all; searched by name, narrowed to audiences, and sorted. Each row is the customer with when it joined, whether and when it was removed, and its conversations, brand share and win rate in this campaign. Also answers the roster's counts, whether it can be changed now (and why not), and the audiences to narrow by.

get/api/v1/discovery/roster-members-v3

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/roster-members-v3
  • 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 customers to return (1–100)

cursorstring

Opaque cursor returned as nextCursor by the previous page

campaignIdstring required

The Discovery campaign's id, or its campaign key.

searchstring

Words a customer's name contains.

audiencesstring[]

Source and label names: a customer in any named source and in any named label (system audiences are labels) is listed; a kind none names narrows nothing.

sortColumn'customerId' | 'name' | 'profile' | 'performance' | 'employer' | 'location' | 'audiences' | 'sources' | 'status' | 'membershipStatus' | 'conversations' | 'brandShare' | 'brandWinRate' | 'age' | 'householdIncome' | 'headcount' | 'annualRevenue' | 'trigger' | 'intentStage' | 'language' | 'createdAt'

Default createdAt.

sortDirection'asc' | 'desc'

Default desc.

status'current' | 'removed' | 'all'

Which memberships to list.

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

Customers the search and audiences keep.

pageIndexinteger required

How many whole pages of this limit sort before the page answered.

facetTotalCountinteger required
querystring required

The search as the roster read it.

editableboolean required

Whether the roster can change now.

editBlockedReasonstring nullable required

Why it cannot, when it cannot.

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.

campaignIdstring uuid required
businessProfileIdstring uuid required
includedinteger required

Customers on the roster now.

currentCountinteger required
removedCountinteger required
archivedInPoolCountinteger required
status'current' | 'removed' | 'all' required

Changes

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