Skip to navigation

Export an analysis as a flat table

Requires analyses:read, or analyses:run for an an_… analysis created by the same key. Flat, joinable tables from a ready analysis — dot-path columns (scores.sentiment, mix.consensus.negativePercent), arrays joined with ;:

  • posts (default): one row per post — join keys (postId, link, platform, account, postedAt, collectionIds, tags), stored scores and mix bars, and matchedComments / shareOfPostComments for this analysis. On a comparison, sides lists the sides a post belongs to.
  • sides: one row per comparison side, with vsSide1 deltas.
  • timeline: one row per period (and per side on a comparison). Needs include: ["timeline"].
  • languages: one row per language (and per side). Needs include: ["languages"].
  • citations: the comments cited by answer. Needs comments:read.

format=json returns rows in data and the column list in meta.columns. format=csv returns text/csv as an attachment; text cells a spreadsheet would read as a formula are prefixed with '. Both count against the daily transfer budget. Nothing is recomputed. Returns 409 analysis_not_ready until ready.

Rate class analysis_export (30 / minute, 500 / day per key).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
X-Api-Keystring
API Key authentication via header

Path parameters

analysisIdstringRequired

Query parameters

tableenumOptionalDefaults to posts
Allowed values:
formatenumOptionalDefaults to json

json (default) or csv. CSV is a text/csv attachment with dot-path column headers; text cells a spreadsheet would read as a formula are prefixed with '.

Allowed values:

Response

Table rows (JSON) or a CSV attachment

datalist of maps from strings to anyOptional

Flat rows keyed by meta.columns.

metaobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error