reports

Export report tables

Export a report's whole table as one CSV file, with the values the report shows, named after the report (name) when given. Pass the report definition as JSON text (definition, as reports_report_tables_get takes it). Answers 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). A definition that does not fit its dataset is 400 INVALID_INPUT; a campaign the organization has no such product campaign for is 404 RESOURCE_NOT_FOUND; a campaign with no results in the scope is 409 PRECONDITION_FAILED (details.reason: no_results). Every export is audited.

get/api/v1/reports/report-tables/export

Request

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

definitionstring required

The report definition as JSON text: {version: 1, grain: "aggregate", dataset, scope: {campaignId (null: every campaign of the product, pooled, where the dataset allows it), dateRange}, rows, columns, values: [{measure, showAs}], filters: [{dimension, values}], sort, compare, chart: {mark, orientation, x, y, topN, labels} | null} or {version: 1, grain: "records", dataset, scope, fields, filters, sort: {field, direction} | null}, its keys the dataset's (reports.datasets.list.v1).

namestring nullable

The report's name, which names the file; omit it for the dataset's.

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

Rows in the file after its header, the total row included.

Changes

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