experience

Get friction map pages (v3)

Get the frictions on one page of an Experience campaign's Journeys map, under the scope experience_friction_maps_get_v3 was read with, over its journeys: those dated in the 30 UTC days ending with its results.asOf. Each friction the scoring engine placed on a step a journey spent on the page, in its own words, with its severity, the campaign's named issue where the issue grouping that runs when a cycle publishes has grouped it, and the journey's replay.

get/api/v1/experience/friction-map-pages-v3/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/friction-map-pages-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

fromstring date-time

The window's start; with to, or neither for all time

tostring date-time

The window's end; with from, or neither for all time

widenWhenEmptyboolean

When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.

segmentsstring[]

Customer-level entries as axis:id (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.

agent'point11' | 'dots' | 'spark' | 'muse' | 'grok_bot'

The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's

destinationstring nullable

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

device'desktop' | 'mobile' | 'ios_safari'

Read only the journeys visited on this device (one of devices); absent reads every device

pagestring required

A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), ":other" for every page past the 12 most reached as one, or ":unknown" for the journeys whose evidence names no page and the frictions seen where no page was recorded

offsetinteger

How many of the page's frictions come before the ones to list: the count already listed, to read on

Headers

Point11-Organizationstring uuid

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

Response

Success.

datasetKeystring nullable required

The drawing these were read for, as experience_friction_maps_get_v3 names its map (map.datasetKey); another key than the map held means the view has changed. Null while the scope holds no interaction or no website to read

pagestring required

A page's host and path with every segment that identifies one thing or one person read as :id (shop.example/products/:id), ":other" for every page past the 12 most reached as one, or ":unknown" for the journeys whose evidence names no page and the frictions seen where no page was recorded

journeysinteger required

Judged journeys with a friction on the page

frictionsinteger required

Every friction on the page; none while the map answers ready false, since no friction can be placed yet

Changes

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