experience

Start diagnostic sessions

Alpha's site test tool, for an Alpha turn only: any other caller (an API key, a dashboard session, an OAuth client, another agent) is refused 403 AUTH_FORBIDDEN. Point11's shopper opens url (a page on one of the organization's own websites, on desktop or a phone) in a real browser, tries task, and the scorer judges it against criteria. It binds no customer or campaign, enters no Experience figure, only looks (never signs in, buys or submits a form), and draws no credits. Returns testId at once, or a refusal (outside_site, unsafe, unavailable); the test takes minutes: read it with experience_diagnostic_sessions_get. The same Idempotency-Key answers the same testId.

post/api/v1/experience/diagnostic-sessions/start

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/experience/diagnostic-sessions/start
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

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

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

urlstring uri required

Where the test starts: an absolute http(s) URL on one of the organization's websites.

taskstring required

What a shopper tries to do, in plain words, as one task (for example: search for odor from the header and open the first result).

criteriastring[] required

What must be true for the task to count as working (for example: a detergent is among the first three results).

device'desktop' | 'mobile' required

Response

Success.

testIdstring uuid nullable required

The started test; null when it was refused.

Changes

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