research

Start creative tests

Test a creative with an exact selected customer-version roster: interpret the creative, then launch one ordinary Research campaign. Name the creative by attachments uploaded with research.study-attachments (images, PDFs, text, MP3 or WAV audio, MP4 or WebM video), or, as a signed-in member, by the artifactId of a Studio creative or package, whose files Research imports under this request. First impressions use natural baseline reactions; buying scenarios prepare separate explicit situational context for every selected person before launch. Name metrics to rate every creative on each of them with one question on one shared scale, which the results' scorecard compares, and platforms to show the creative as people would meet it there. Preparation calls use Alpha credits and interviews use Research. With artifactId, brief is what to learn, in the member's words; Research names the creative by its title. Before anything is paid for, the start refuses an audience or seller it cannot use, more customers than a study interviews, files past a study's attachment bound, and an organization whose plan would refuse the test's interviews (research_creative_test_quotes_get answers the same first); pass that quote's expectedPrice to refuse a start whose interview price changed since. A same-key retry of an admitted test answers it with the exact frozen selection and imported files, without reading the creative again; read research_creative_tests_get_v2 for progress and research_results_get_v7 for the launched run's results.

post/api/v1/research/creative-tests/start

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/creative-tests/start
  • 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)

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

namestring required
briefstring required

What to learn from the creative. With artifactId, Research names the selected creative before it; with attachments, the whole brief.

sellerProfileIdstring uuid nullable required
contentLanguage'en' | 'fr' | 'es' | 'de' | 'pt' | 'ja' | 'it' | 'nl' | 'sv' | 'cs' | 'pl' | 'tr' | 'ru' | 'zh-Hans' | 'ko' | 'ar' required
audienceNotestring

Anything more about who the people taking part are, in the member's own words; the Designer reads it after the brief.

metricsstring[]

What to rate each creative on. Each becomes one rating question per creative, which the results' scorecard compares. Omit to let the study choose its own questions.

chooseMetricstrue

Let the study's Designer choose, from the brief, which metrics to rate each creative on (or none), as many as fit one study. Takes no metrics.

platformsstring[]

Where the creative might run; the study shows it as people would meet it there. Platform fit needs at least one.

artifactIdstring uuid

An exact Studio creative artifact or package the signed-in member may read; Research imports its files under this request's Idempotency-Key. Members only; an API key passes attachments.

Response

Accepted: the durable run started. Follow it with GET /api/v1/platform/runs-v2/{id}.

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.