Analytics

List deal analytics

GET/analytics/reports/deals
analytics:readlist_deal_report_rowsRead-only

Lists one row per deal with its details and event counts: views, enquiries, commitments, amounts funded and committed, and whether it has closed. Rows are the deals GET /deals lists for you (an entrepreneur's organisation, else the tenant's), from the analytics store, which trails live data; an unsynced deal has no row. Amounts are in the deal's own currency, never converted. updated_at is when the store last changed the row, not the deal. Use GET /analytics/deals/{id} for one figure over all deals. It only reads.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    Comma-separated fields to sort by: name, status, created_at, published_at, views, unique_viewers, engagements, commitments, committed_amount, funded_amount, funded_percent or last_event_at. Prefix a field with - for descending. Defaults to -created_at. A deal never published, or with no events, sorts as the oldest.

  • filter[q]string#

    Deals whose name contains this text, ignoring case.

  • filter[status]string#

    Only deals in this stored status: draft, awaiting_approval, ready_to_publish, published, retired, in_progress or rejected. A published deal past its end date is still published here; use filter[closed] for it. Takes [in] and [not_in] with a comma-separated list.

    One of: draft, awaiting_approval, ready_to_publish, published, retired, in_progress, rejected
  • filter[created_at]string (date-time)#

    Only deals the analytics store first saw in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

  • filter[published_at]string (date-time)#

    Only deals published in a range, written filter[published_at][gte]=2026-10-01. Takes gt, gte, lt and lte. A deal never published has no published_at and never matches.

  • filter[closed]boolean#

    true gives only closed deals, retired or published and past their end date; false gives the rest.

  • filter[views]integer#

    Only deals by how many views they have, written filter[views][lte]=0 for deals nobody viewed. Takes whole numbers with eq, gt, gte, lt, lte, [in] and [not_in].

  • filter[funded_percent]integer#

    Only deals by funded_percent, written filter[funded_percent][gte]=100 for fully funded deals. Takes whole numbers with eq, gt, gte, lt, lte, [in] and [not_in]; the two-decimal figure is compared as it is.

Responses

200

One page of deal rows.

DealReportRow[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "status": "draft",
      "currency": "string",
      "funding_sought": 1,
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00",
      "published_at": "2026-06-12T10:00:00+00:00",
      "available_from": "2026-06-12T10:00:00+00:00",
      "available_to": "2026-06-12T10:00:00+00:00",
      "closed": true,
      "views": 1,
      "unique_viewers": 1,
      "enquiries": 1,
      "engagements": 1,
      "commitments": 1,
      "committed_amount": 1,
      "funded_amount": 1,
      "funded_percent": 1,
      "last_event_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/analytics/reports/deals\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"