campaigns

List summaries

Deprecated: use campaigns.summaries.list.v2 (campaigns_summaries_list_v2) for every product's work counted by its entries and a Mirror's customers. 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, work progress (an Experience campaign's counts its current cycle's visits), setup readiness, and whether the account admits its new work. Returns totalCount and whether the organization has any campaign at all.

get/api/v1/campaigns/summaries

Request

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

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

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