experience

Get campaigns (v3)

Get one Experience campaign's scope and progress: its websites, date window, results window (the day its figures are as of and the interactions and customers the 30 days ending with it hold), and how many journeys are scheduled, running, and finished. Set journeys to also read one page of its journeys in that window, as experience_journeys_list_v5 lists them. Read its figures with experience_campaign_analytics_get_v9.

get/api/v1/experience/campaigns-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/campaigns-v3/{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 Experience campaign's id

Query parameters

Absent or null reads all time

Customer-level entries and the agent (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together. The campaign's own planned and running counts stay campaign-wide and every agent's.

destinationstring nullable

A campaign website's id (destinations[].id) or name; absent reads the campaign's own measured website

journeysboolean

Also read one page of the campaign's journeys (journeys), as experience_journeys_list_v5 lists them, in the same read: over the window this read resolves (dateScope.window) and its segments, filtered and sorted by the journeys* fields (ignored without it)

journeysWebsitestring

Only journeys to this campaign website (a destinations[].id); absent, or an id none of the campaign's websites has, is every website

journeysCursorstring

Opaque cursor returned as journeys.nextCursor or journeys.previousCursor by another page

journeysSearchstring

The page's search over customer, website and coverage; it matches on the first 200 characters

journeysOutcome'all' | 'achieved' | 'not-achieved' | 'unavailable' | 'unscored' | 'limited'

achieved and not-achieved are a pass and a fail; unavailable is every settled visit with neither verdict (unscored, could not tell, or limited evidence), of which unscored and limited are the narrower parts

journeysFrictionboolean

Only journeys the evaluator found friction in

journeysDevice'desktop' | 'mobile' | 'ios_safari' nullable

Only journeys on this device; absent is every device

journeysSort'customer' | 'desktop' | 'mobile' | 'ios_safari' | 'completedAt'

What the page sorts by: a device sorts by quality among its passed journeys

journeysSortDescboolean

Sort descending (the default)

Headers

Point11-Organizationstring uuid

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

Response

Success.

destinationIconsobject required

Each website's stored favicon by destinations[].id; one without (no URL, or none stored) is absent and draws its name's initial

Changes

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