DocsAPI reference

Page cues API

The questions an agent offers on each page of a site. List every page it can open a conversation about, with how often each cue was shown, opened and asked; write questions for indexed pages that have none or again for one page; and edit a page's opener and questions, hide one, or switch the page off. Edits are the owner's and are never overwritten.

On this page
  1. Endpoints
  2. Authentication
  3. Objects returned

Endpoints#

4 operations, each with its parameters, schemas and an example request on its own page.

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

PageCuesList3 fields
  • itemsarray of PageCuesReadrequired
    12 fieldsPageCuesRead
    • idstringrequired
    • page_typestringrequired
    • urlstringrequired
    • cuesarray of CueRead
      8 fieldsCueRead
      • idstringrequired
      • sourcestringrequired

        One of: owner, mined, generated

      • textstringrequired
      • askedinteger

        Default: 0

      • hiddenboolean

        Default: false

      • open_ratenumber | null
      • openedinteger

        Default: 0

      • showninteger

        Default: 0

    • disabledboolean

      Default: false

    • generated_atstring | null
    • languagestring | null
    • mined_atstring | null
    • openerstring | null
    • owner_edited_atstring | null
    • titlestring | null
    • updated_atstring | null
  • pendingintegerrequired
  • totalintegerrequired
CuesQueued2 fields
  • messagestringrequired
  • queuedbooleanrequired
PageCuesRead12 fields
  • idstringrequired
  • page_typestringrequired
  • urlstringrequired
  • cuesarray of CueRead
    8 fieldsCueRead
    • idstringrequired
    • sourcestringrequired

      One of: owner, mined, generated

    • textstringrequired
    • askedinteger

      Default: 0

    • hiddenboolean

      Default: false

    • open_ratenumber | null
    • openedinteger

      Default: 0

    • showninteger

      Default: 0

  • disabledboolean

    Default: false

  • generated_atstring | null
  • languagestring | null
  • mined_atstring | null
  • openerstring | null
  • owner_edited_atstring | null
  • titlestring | null
  • updated_atstring | null

Something unclear or missing? Tell us and we’ll fix it.