research

Get result segments (v4)

Get one Research campaign's results campaign-wide and under each audience, channel, store, product (revenue line), tone and topic entry: for every question research_results_get_v7 shows, in study order, the campaign-wide figure and each entry's, counted as research_results_get_v7 counts it with that entry as segments (answers, distinct respondents, slices, lead figure, a scale's average). Entries are the audiences, channels and stores research_campaign_segments_get lists (same ids and labels), then the products the campaign's customers carry, each with the most answers any question counted under it; a respondent counts under the entries of the customer version they answered as. Pass dateRange as research_results_get_v7 takes it, or runId for one saved run as it ran; axis reads one axis's entries, each counted as in the full read. Another organization's campaign or run is not found.

get/api/v1/research/result-segments-v4/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/result-segments-v4/{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.

Query parameters

runIdstring uuid

One of the campaign's customer-triggered runs, read as it ran. Omit for the date range.

The days the figures are read over, as research.results.get.v5 takes them; omit for the last 90 days, widened to All time when they hold no interview. Ignored with runId.

axis'audience' | 'channel' | 'store' | 'product' | 'sentiment' | 'topic'

One axis: its entries alone, each figure exactly as the read of every axis counts it. Omit for every axis.

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
descriptionstring nullable required

The study's description as its author wrote it; null when it has none.

runIdstring uuid nullable required

The run whose synthesis the cards show; null before any run.

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.