reports

Get report tables

Read one page of a report's table: pass what the report reads as id (the campaign its definition's scope.campaignId names, or the organization's id for a report of every campaign, scope.campaignId null, narrowed to one business profile's by scope.profileId) and the report definition as JSON text (definition, the shape reports_saved_reports_save takes; a definition whose scope names another campaign is not found under id, as is a campaign of another profile than scope.profileId). An aggregate report answers its flat columns (each measure under each combination of column values, shown as itself or as a share of its row, column or total), this page of rows with each value's precision and, when it compares, its value over the window 30 days earlier, the grand total row and, when its definition draws a chart (chart), that chart (table.chart): the first chart.topN categories along x (every day, at most 1,000; every part of a pie, at most 5) and at most 5 series, each point the table's own cell at that row and column, with how many categories and series the report holds and no Other for the rest, or why the data cannot draw it (status: refused); a records report answers this page of interactions with the fields it shows. Every figure is the product's own, as its dashboard reads it for the same campaign and dates. A definition that does not fit its dataset is 400 INVALID_INPUT with details.issues naming each field; a campaign the organization has no such product campaign for is 404 RESOURCE_NOT_FOUND; a campaign with no results in the scope answers status: no-results. Page with after (the previous page's nextCursor) and pageSize.

get/api/v1/reports/report-tables/{id}

Request

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

Path parameters

idstring uuid required

What the report reads: its definition's scope.campaignId, or the organization's id when the report reads every campaign of its product (scope.campaignId null).

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).

afterstring nullable

The previous page's nextCursor; omit it for the first page.

pageSizeinteger

Rows per page (1–1000).

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

Changes

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