discovery

List report rows (v2)

Deprecated: use reports.report-tables.get.v1 (reports_report_tables_get). Page through a campaign's report table for one row dimension (conversations, customers, or win reasons, loss reasons, decision factors, sentiment themes) with chosen columns, filters, sort, and search, over the campaign's conversations dated in the 30 days ending the results window's as-of day (scope.window). Each table is read through the report dataset that replaced it: conversations as discovery.conversations lists them, customers by customer from discovery.brand-performance, reasons from discovery.reasons (a win reason of a conversation the brand won, the brand's gap to the winner in one it did not), sentiment themes from discovery.sentiment-themes (the campaign brand's). What no dataset names is left out: decision factors list no row, and a customer's job title, employer and groups and a conversation's decision factor are null.

get/api/v1/discovery/report-rows-v2

Request

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

limitinteger

Number of items to return (1–1000)

cursorstring

Opaque cursor returned as nextCursor by the previous page

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 read to these segments, ANDed: one axis:id per axis (any number of distinct customer: entries), in canonical axis order. Empty reads the whole dispatch.

dimension'conversations' | 'customers' | 'win-reasons' | 'loss-reasons' | 'decision-factors' | 'positive-sentiment' | 'negative-sentiment' required

What one row is: a conversation, a customer, or a win reason, loss reason, decision factor, or sentiment theme with the conversations citing it.

columnsstring[] required

The dimension's fields each row carries, in order. conversations: customerName, engine, date, winner, sentiment, decisionFactor, topics. customers: name, conversations, jobTitle, employer, groups, winRate. Every label dimension: name, conversations, share.

filtersstring[]

Every filter must hold (AND).

sortColumnstring

Omit to keep the dimension's own order.

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.

nextCursorstring nullable required
totalCountnumber nullable required

Rows the filters and query keep; null unless scope.state is ready.

unfilteredRowCountnumber nullable required

Rows before filters and query; null unless scope.state is ready.

Changes

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