Reports

Build a Publisher Reporting V2 report

Returns selected JSON rows without publisher identity, a full filtered summary, pagination, and report metadata.

get/analysis/publisher-reporting/v2/report/

Request

Query parameters

fromstring date

First inclusive UTC date paired with to, or omitted with it.

tostring date

Last inclusive UTC date paired with from, not in the future, and within available history.

metricsPublisherMetric[]

Unique comma-separated metrics set response order, while omission selects all metrics in canonical order.

time_grain'total' | 'day' | 'week' | 'month' | 'hour'

UTC period grain with total as default and Monday-based clipped week and month periods.

group_bystring[]

Up to three unique grouping keys from page_type, widget_type, and widget_id are accepted.

sort_order'desc' | 'asc'

Periods use desc for latest first or asc for oldest first, with grouping values ascending.

page_typesstring[]

Filter to up to 250 comma-separated page types. ORDER_TRACKING and MODAL are excluded.

widget_typesstring[]

Filter to up to 250 comma-separated widget types without adding a grouping column.

offsetinteger

Rows to skip after sorting.

limitinteger

Number of JSON rows in a page.

Response

Paginated Publisher report and complete filtered summary.

Example response

{
  "data": [
    {
      "period_start": "2026-07-18T00:00:00Z",
      "period_end": "2026-07-19T00:00:00Z",
      "page_type": "THANK_YOU",
      "widget_type": "SHOPIFY_NATIVE_ESSENTIAL",
      "widget_id": "post-purchase-primary",
      "publisher_payout": 1250,
      "widget_loads": 12000,
      "widget_displays": 10000,
      "viewable_widget_displays": 9200,
      "impressions": 8500,
      "clicks": 340,
      "conversions": 100,
      "ctr": 0.04,
      "cvr": 0.01
    }
  ],
  "summary": {
    "publisher_payout": 1250,
    "widget_loads": 12000,
    "widget_displays": 10000,
    "viewable_widget_displays": 9200,
    "impressions": 8500,
    "clicks": 340,
    "conversions": 100,
    "ctr": 0.04,
    "cvr": 0.01
  },
  "pagination": {
    "limit": 50,
    "total": 1
  },
  "meta": {
    "data_through": "2026-07-20T00:00:00Z",
    "request_id": "b40ff2aa-31d5-4f4f-9b1e-798543c1f9d2"
  }
}

Changes

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