research

Get result segment axes (v2)

Get which axes one Research campaign's results breakdown (research_result_segments_get_v4) lists an entry on, without counting a figure: audience, channel, store and product (revenue line) when the campaign's customers carry one, and tone and topic when the respondents of the range from to to (the days research_results_get_v7's range names) take one, read from every accepted answer of those days, so after a study's edit a tone or topic can come from answers to the earlier study alone. Omit from and to before the campaign's first interview to read the customers' axes alone. A campaign your organization does not own is not found.

get/api/v1/research/result-segment-axes-v2/{id}

Request

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

fromstring date

The range's first UTC day, as research.results.get.v5's range names it: tones and topics are read over its days. Omit it and to before the campaign's first interview.

tostring date

The range's last UTC day, as research.results.get.v5's range names it.

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
axesstring[] required

The axes research.result-segments.get.v4 lists an entry on, in its order: audience, channel, store, product, sentiment, topic.

Changes

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