research

Get creative tests

Deprecated: use research.creative-tests.get.v2 (research_creative_tests_get_v2), which also names why a test failed, what it froze and each participant's preparation. Read this caller's creative test by its start request's Idempotency-Key: its exact selection, shared interpretation, preparation counts and the progress of the ordinary Research run it launched, without generating more work. Once launched, campaignId and runId name that run's results.

get/api/v1/research/creative-tests/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/creative-tests/{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 start request's Idempotency-Key.

Headers

Point11-Organizationstring uuid

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

Response

Success.

namestring required
preparationRunIdstring uuid required
status'preparing' | 'unsupported' | 'failed' | 'launched' required

A test cancelled after launch (its campaign deleted, or its run stopped) reads failed here; research_creative_tests_get_v2 reads it cancelled.

campaignIdstring uuid nullable required
runIdstring uuid nullable required
messagestring nullable required
metricsstring[] required

What each creative is rated on, as the start named them or the Designer chose them; empty when the study chose its own questions, and until the Designer has chosen.

platformsstring[] required

Where the creative might run.

phase'reading_creative' | 'preparing_participants' | 'interviewing' | 'analyzing' | 'results' | 'failed' | 'unsupported' required
plannedInterviewCountinteger required

Changes

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