research

Get results (v5)

Deprecated: use research.results.get.v7 (research_results_get_v7) for native audio; this version leaves audio out: a question card that showed audio shows no file. Get one Research campaign's results over a date range. Every figure counts the interviews completed on the range's UTC days (All time: every interview), an answer counting toward a question of the current study only when its interview's study asked that question exactly so; results are no time series, so nothing is read as of a day or compared with an earlier window. Answers the range (its days, interviews and customers), one card per question of the current study (the file or video it showed, figure, distribution, headline value with the distinct respondents behind it, the newest run's summary and evidence), the study's headline scorecard, and the newest run's status and coverage. Pass dateRange (by default the last 90 days, widened to All time when they hold no interview), segments to narrow the figures, or runId for one saved run as it ran, with no range.

get/api/v1/research/results-v5/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/results-v5/{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 campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.

Query parameters

runIdstring uuid

One customer-triggered run, read as it ran; without id its own campaign is read, with id it must be that campaign's. Omit for the date range.

Entries from research.campaign-segments.get.v1; figures count only respondents inside them. Accepts only the audience, channel, store, customer axes; an entry on any other axis is refused as 400 INVALID_INPUT.

The days the figures are read over; omit for the last 90 days, widened to All time when they hold no interview, as the dashboard's default. Ignored with runId.

Headers

Point11-Organizationstring uuid

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

Response

Success.

campaignIdstring uuid required
study'ad_copy' | 'brand_health' | 'offers' | 'pricing' | 'product' | 'product_launch' | 'sales' | 'custom' | 'product_roadmap' | 'purchasing' | 'competitors' required
descriptionstring nullable required

The study's description as its author wrote it under the name in the study editor; null when it has none, as on every study launched before launch kept it.

assumptionsstring[] required

The customer assumptions every answer assumes: statements each respondent took as true of themselves for this study only, beside their own profile, in order. A saved run (runId) answers the ones it froze: the study's, and any a backtest's rerun added. Empty when the study states none.

onCalendarboolean required

The study runs weekly or monthly, so a settings Save changes it from its next admission day; false for a study that runs once.

runIdstring uuid nullable required

The run whose status, coverage and synthesized titles, summaries and quotes the results show: the saved run named, else the newest run with an interview in the date range; null before any run.

runDaystring date nullable required

The UTC day the run started; null before any run.

runStatus'running' | 'succeeded' | 'failed' | 'cancelled' | 'partial' nullable required
runDelayedboolean required

The running run is past its phase's maximum wait with no terminal receipt.

analysisRerunnableboolean required

The run failed after its interviews were analyzed; research.runs.reanalyze.v1 re-runs its analysis at no interview charge.

widenedToAllTimeboolean required

A dateRange with widenWhenEmpty held no interview, so the figures read All time.

Changes

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