Actually Asked

Asks Actually Asked to draft more FAQ entries from the site's pages now, rather than at the next read. Only when no suggestions are waiting: review those first. The drafts appear as suggested entries in a few minutes (list_faq_entries with state suggested). A few drafts an hour at most per site.

draft_faq_suggestions

Changes any of a FAQ entry's question, answer, group, own page rule, own tag and pin; what you leave out stays. Changing the wording makes the entry the merchant's (the system never rewrites it), clears "may be outdated", and publishes a suggestion (under its proposed group unless you give another). Moving or pinning alone changes only that. To publish a suggestion as it is, use publish_faq_entries.

update_faq_entry

Renames a group, or changes where it shows: its page rule and its tag (Growth and up). General can't be renamed. Check the result on a page with preview_faq_for_page.

update_faq_group

Renames a page rule or replaces its paths. Everywhere, Home and FAQ page can't be renamed, and only the FAQ page's paths can change.

update_page_rule

One FAQ entry in full: the answer as markdown, its group, its own page rule and tag, its pin, where it came from, whether the merchant edited it (the system never rewrites those), and whether it may be out of date. A suggestion also says where publishing it puts it, and any entry lists the groups and page rules suggested for it.

get_faq_entry

One visitor question in full: the page it was asked on, any text the visitor highlighted (and the paragraph and heading around it), the answer they were given and the pages it came from, the FAQ entry it matched, the visitor's email if they left one, and whether it can be discarded.

get_question

How to put the FAQ widget on a site: the snippet with this site's key, the full FAQ page and tag variants, and where they go on the site's platform. check_install confirms it's on a page.

get_install_instructions

What the FAQ widget says and how it looks on a site: how many questions it shows, its heading, hint and ask item, and its look (preset, layout, colours and sizes; null is the site's own). A Shopify store's look is set in its theme editor, so it has none here. update_widget_settings changes them.

get_widget_settings

A site's FAQ entries with a short excerpt of each answer. live (the default): published, in the order a page shows them (the entries in no group first, then each group in order; within each, pins first, then by how often visitors ask). suggested: drafted from the site's pages, waiting to be published or dismissed. removed: taken out of the FAQ; they are never suggested or published again unless restored. get_faq_entry has the whole answer.

list_faq_entries

A site's FAQ groups in the order a page shows them: the headings questions sit under. A group shows on the pages its page rule matches and on any page whose snippet carries its tag. Every site has General, on the FAQ page rule; it can't be renamed or deleted. Each group lists how many live entries it has and how many placements are suggested for it.

list_faq_groups

Visitors who left their email under a question the site couldn't answer, newest first: waiting for the merchant's reply (the default), replied, or all. The merchant replies from their own email; nothing here sends mail.

list_leads

A site's page rules: parts of the site picked out by their paths (an exact path like /pages/care, or a prefix ending in * like /products/*). Groups show where their rule matches, and an entry can have a rule of its own too. A page matches every rule whose path fits it. Every site has Everywhere (/*), Home (/) and FAQ page (/faq); they can't be renamed or deleted, and only the FAQ page's paths can change.

list_page_rules

The sites in the connected account: each one's plan and what it allows (groups from Starter; page rules and tags from Growth; how many entries can be pinned), whether it's paused, whether the widget is live on it, and what's waiting: questions this month, leads waiting for a reply, suggested FAQ entries and suggested placements. Start here.

list_sites

Where Actually Asked suggests live FAQ entries belong: a group to sit under, or a page rule to show on. Nothing moves until the merchant accepts; a declined suggestion is never made again. Optionally only those for one group or page rule.

list_placement_suggestions

What visitors asked on a site, newest first: answered (from the site's pages), matched (with an existing FAQ entry), unanswered (nothing on the site answered it: a gap worth adding to the FAQ), out_of_scope (needed live data such as an order's status). Archived questions are left out unless archived is true. get_question has the full detail.

list_questions

Marks a lead replied, once the merchant has answered the visitor from their own email, or back to waiting. Nothing here sends mail.

update_lead

What the FAQ shows on one page of the site, worked out exactly as the widget does: the sections (the entries in no group first, then each group in order) and their questions. widget (the default) is the top entries a normal snippet shows; full is a full FAQ page (data-faq-layout="full"). Use it to check a page rule or tag change.

preview_faq_for_page

Publishes suggested entries as they are, each under its proposed group (made, with a page rule for its page, when the site doesn't have it yet). Give entry_ids, or all: true for every waiting suggestion. Read each one first (get_faq_entry) and check its answer against the site's pages; edit with update_faq_entry where it's wrong.

publish_faq_entries

The text of one page, product, policy or file part Actually Asked has read, by the document_id search_site_content gave. Long pages are cut at 20,000 characters. A file is cited as a file: never link to it.

get_document

Takes a live entry out of the FAQ, or dismisses a suggestion. It is kept, so the same question is never suggested or published again, and restore_faq_entry brings it back.

remove_faq_entry

Puts a site's groups in a new order: the order their headings show in, after the questions in no group. Give every group.

reorder_faq_groups

Puts a group's pinned entries in a new order (pins show first, in this order, before the entries ranked by how often visitors ask). Give every pinned entry of the group. Pin or unpin with update_faq_entry.

reorder_pinned_entries

Brings a removed entry back: into the FAQ if it was live, or back to the suggestions if it was a dismissed suggestion.

restore_faq_entry

Full-text search over everything Actually Asked has read for a site (its pages, products, policies and uploaded files), the same search that answers visitors. Returns the best passages with their page. Write and check FAQ answers from these, not from general knowledge. A file's passages are cited as a file: never link to them.

search_site_content