campaigns

List summaries (v2)

Changed on

List the organization's campaigns across Discovery, Experience and Research, optionally one product and one lifecycle status, sorted by a column. Each row carries its schedule, its work counted by its entries (each launch, scheduled firing or run now: a Discovery dispatch, an Experience cycle, a Research run), its customer work in flight from its product's calendar, setup readiness, and whether the account admits its new work; an Experience Mirror's customers are its source Discovery campaign's. Returns totalCount and whether the organization has any campaign at all.

get/api/v1/campaigns/summaries-v2

Request

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

product'discovery' | 'research' | 'experience'

Only this product's campaigns; omit for every product.

view'all' | 'active' | 'paused' | 'archived'

Only campaigns in this lifecycle status; "all" (the default) is every one.

sort'name' | 'brandUrl' | 'type' | 'updatedAt' | 'scheduleType' | 'frequency' | 'sourceCampaign'

The column to sort by. Every product sorts by name, type and updatedAt; one product also by brandUrl; Experience also by scheduleType, frequency and sourceCampaign. Any other sorts by updatedAt, newest first.

descendingboolean

Sort descending; ignored without sort.

brandIconsboolean

false reads no brand favicons, for a caller that draws none: every row's brandIcon is then null. Omit it, or pass true, to read each row's.

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

Campaigns matching the product and status filters.

hasCampaignsboolean required

Whether the organization has any listed campaign of this product at all.

Changes

  • 5241805fe425Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status