research

Export results

Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export), which exports a report of research.answers counted by the same read over any date range. This version exports research.results.get.v5's default read with its published columns: its lead figure names an open question's score alone and its change column is always empty, since a range compares with nothing. Export one Research campaign's results as CSV, as the results page draws them under the same scope, one line per answer row of each question. Answers the whole file inline as content. Pass runId for one saved run, and segments to narrow the figures.

get/api/v1/research/results/export

Request

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

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.