iAdvizeDocs

Read the performance of a site's starter questions over a period

Returns the questions shown at least once in the period, with the figures the dashboard's Starter performance tab shows: impressions, clicks and click rate, in total and per surface, and the verdict against the site's own click rate. A question shown to nobody is not listed; `meta.notShownCount` counts them. The default order is the most shown first. Sorting by `rate` orders the whole result, and a cursor is bound to the period, the device and the sort it was issued for. `from` and `to` are required UTC days, at most 366 days apart.

GET
/api/v1/sites/{siteId}/starter-questions/performance

Authorization

ApiKeyAuth
AuthorizationBearer <token>

A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).

In: header

Path Parameters

siteId*string

The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.

Query Parameters

from*string

First UTC calendar day of the period, YYYY-MM-DD, included.

Formatdate
to*string

Last UTC calendar day of the period, YYYY-MM-DD, included. The period is at most 366 days.

Formatdate
device?string

Only this device. One value: for several devices, make one call each.

Value in

  • "desktop"
  • "mobile"
  • "tablet"
  • "unknown"
sort?string

What to sort on. Impressions by default.

Value in

  • "impressions"
  • "clicks"
  • "rate"
order?string

The sort direction. desc by default.

Value in

  • "asc"
  • "desc"
cursor?string

The meta.nextCursor of the previous page, with the same filters.

limit?integer

The page size, 1 to 100.

Range1 <= value <= 100
Default50

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/v1/sites/string/starter-questions/performance?from=2019-08-24&to=2019-08-24"
{  "data": [    {      "id": "stq_01kvnwmagvf27rc9cze5rm9e1r",      "label": "Is it waterproof?",      "impressions": 1200,      "clicks": 96,      "clickRate": 0.08,      "surfaces": [        {          "surface": "composer",          "impressions": 900,          "clicks": 81,          "clickRate": 0.09        },        {          "surface": "starters",          "impressions": 300,          "clicks": 15,          "clickRate": 0.05        }      ],      "verdict": "workhorse"    }  ],  "meta": {    "nextCursor": null,    "matching": 1,    "notShownCount": 4,    "siteClickRate": 0.05,    "period": {      "from": "2026-10-01",      "to": "2026-10-14"    }  }}

Delete a starter question

Removes the question and its text in every language. Returns the id and a deleted flag.

List a site's conversations

Returns the conversations run through this site's agents, newest first by creation time, with their context, feedback, engagement and a summary of their labels. The list is scoped to the site in the path and to the organization of the API key. Filters combine with AND: `labels.all` needs every token, each `labels.any` group (tokens separated by `|`) needs one of its tokens, and `labels.none` excludes tokens and needs a positive label filter or a date range. `limit` is 1 to 100 (25 by default), and a cursor is bound to the filters it was issued for. Read-only: conversations are created by the agent, never via this API.