research

Export results (v3)

Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export), which exports a report of research.answers over a date range (each question's answers by share, answers, respondents and a rating question's average, everyone's or across one segment axis), counted by the same read; only this version reads one saved run (runId) or narrows by segments, and adds each question's type, a ranking's average rank and the headline. This version stays served as published. Export one Research campaign's results as CSV, as the results page draws them: one line per answer row of each question (options most chosen first, a ranking's best average rank first, a scale's points highest first, a paragraph's tones, a computer task's completion), each with the question's number, text, type and responses, the row's share, a ranking's average rank, a scale's average and the question's headline figure, counted as research_results_get_v7 counts them. Answers the whole file inline as content. Pass from and to for the date range (by default the last 90 days, widened to All time when they hold no interview), runId for one saved run as it ran, and segments to narrow the figures, as research_results_get_v7 takes them.

get/api/v1/research/results/export-v3

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/research/results/export-v3
  • 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)

Query parameters

idstring uuid

The campaign id from research.campaigns.list.v1; optional with runId, whose own campaign is read.

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.

segmentsstring[]

Entries from research.campaign-segments.get.v1 as axis:id; 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.

fromstring date

The date range's first UTC day; omit both from and to for the last 90 days, widened to All time when they hold no interview, or from alone for All time.

tostring date

The date range's last UTC day; omit for today.

Headers

Point11-Organizationstring uuid

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

Response

Success.

fileNamestring required
mediaType'text/csv' required
contentstring required

The whole file: a header line, then one line per answer row.

rowCountinteger required

Lines after the header.

Changes

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