discovery

Export report tables (v2)

Deprecated: use reports.report-tables.export.v1 (reports_report_tables_export). Export every row of a campaign's report table for one dimension, with chosen columns, filters, sort, and search, as CSV (cells as the dashboard displays them), over the campaign's results window. Answers that window (scope.window) and the file's name, type and size with a short-lived url to GET it (fetch it before expiresAt; call again for a fresh export). Each table is read through the report dataset that replaced it (segments from discovery.brand-performance, sources from discovery.sources, and the row tables as discovery.report-rows.list.v2 reads them); what no dataset names is left out: locations and decision factors export no row, and a source's type is empty. The competitors table lists the campaign's own brand among the brands, as the Competitors leaderboard does. Every export is audited.

get/api/v1/discovery/report-tables/export-v2

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/report-tables/export-v2
  • 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 required

Discovery campaign id.

dateRangestring nullable

Result window: all, a preset id, or yyyy-MM-dd..yyyy-MM-dd. Omit for the campaign's default window.

segmentsstring[]

Narrows the table to these axis:id segments, ANDed; entries the campaign does not have are ignored, as the dashboard ignores them.

dimension'revenue' | 'audiences' | 'channels' | 'locations' | 'topics' | 'competitors' | 'engines' | 'sources' | 'conversations' | 'customers' | 'win-reasons' | 'loss-reasons' | 'decision-factors' | 'positive-sentiment' | 'negative-sentiment' required

What one row is: a product (revenue: one of the business's revenue lines), audience, channel, location, topic, competitor, engine, or source (the campaign's reports), or a conversation, customer, win reason, loss reason, decision factor, or sentiment theme.

rowsboolean

Default true. False exports the header line alone, as the report builder shows a table whose rows are unset.

columnsstring[]

The dimension's columns, in order; the name column always leads when rows are exported. Omit (or send none) for the dimension's default columns.

filtersstring[]

Every filter must hold (AND); numeric columns take gt, lt, equals with a number.

sortColumnstring

The column to sort by; none keeps the dimension's own order. Omit for the dimension's default sort.

sortDirection'asc' | 'desc'

With sortColumn; default asc.

searchstring

Free text matched against the selected columns as displayed.

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

Suggested file name for saving the bytes

contentTypestring required
byteLengthinteger required
urlstring uri nullable required

Short-lived presigned URL that GETs the bytes; null when this deployment cannot sign the object

expiresAtstring date-time nullable required

When url stops working (minutes after the call); null with url

exportIdstring uuid required

This export's id, recorded on its audit row.

rowCountinteger required

Table rows in the file, after the header.

format'csv' required
dimension'revenue' | 'audiences' | 'channels' | 'locations' | 'topics' | 'competitors' | 'engines' | 'sources' | 'conversations' | 'customers' | 'win-reasons' | 'loss-reasons' | 'decision-factors' | 'positive-sentiment' | 'negative-sentiment' required

Changes

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