iAdvizeDocs

Delete a starter question

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

DELETE
/api/v1/sites/{siteId}/starter-questions/{id}

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.

id*string

The starter question id (prefixed stq_).

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://example.com/api/v1/sites/string/starter-questions/string"
{  "data": {    "id": "stq_01kvnwmagvf27rc9cze5rm9e1r",    "deleted": true  }}

Move a starter question

Moves the question up (toward the head) or down in the library, one place by default or `steps` places, stopping at the edge. One request is one move and records one audit entry, whatever the distance. Returns the question with its new position.

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.