reports

List dimension values

List the values one dimension can take in a report's scope, as the report's Filter offers them: pass the report definition as JSON text (definition, as reports_report_tables_get takes it) and a dimension its dataset filters by (dimension, as reports_datasets_list names it). Each value names its key, which a filter's values keeps, and its label as the product names it (a customer's name, a store's, a run's start day, an outcome). A dimension a report can group by lists the values the product's figures hold in the definition's campaign and dates, under its other filters, ordered by label; one a dataset only filters by (a store, a customer, a run) or a records field nothing groups by (an outcome) lists every value the product offers there in the product's own order, such as the customers and stores of the campaigns the report reads. The definition's own filter on the dimension narrows nothing. search keeps the values whose label contains it, any case, or whose key is it. A definition that does not fit its dataset, or a dimension its dataset does not filter by, is 400 INVALID_INPUT with details.issues; a campaign the organization has no such product campaign for is 404 RESOURCE_NOT_FOUND. Page with limit and cursor.

get/api/v1/reports/dimension-values

Request

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

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

dimensionstring required

A dimension key the definition's dataset filters by.

searchstring nullable

Keep the values whose label contains this text, any case, or whose key is it; omit it for every value.

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

Changes

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