List the fleet | Context Link

The whole fleet

The API behind the fleet screen:

Response fields

api_accounts·array

One summary row per api_account on this page, oldest first.

Fields

• api_accounts[].id·integer
  • Context Link's own id for the account.
• api_accounts[].uid·string
  • The customer id you provisioned the account with.
• api_accounts[].label·string
  • The account's display name, falling back to the uid.
• api_accounts[].site_url·string
  • The website being crawled, null for an account with no website.
• api_accounts[].sync_status·string
  • The crawl state: unsynced, syncing, synced, error_syncing, or no_site for an account with no website.
• api_accounts[].index_ready·boolean
  • Whether the account's website has completed a successful crawl.
• api_accounts[].posts·integer
  • Documents indexed across every connection the account owns.
• api_accounts[].chunks·integer
  • Embedded passages indexed across every connection the account owns.

Usage

usage·object

Organisation-wide totals, independent of the page of accounts returned.

• usage.api_users_count·integer
  • api_accounts currently provisioned across your whole organisation.
• usage.api_users_allowance·integer
  • Total api_account slots your subscription covers, which is 10 per bundle.
• usage.bundles·integer
  • Bundles currently on your subscription, or 0 when the organisation is off the white-label plan.
• usage.slots_available·integer
  • Slots left before the next bundle is auto-added on overflow.

Pagination

pagination·object

Paging state for the api_accounts array.

• pagination.page·integer
  • The page returned, starting at 1.
• pagination.per_page·integer
  • Rows per page, capped at 100.
• pagination.total·integer
  • api_accounts matching the request across every page.
• pagination.total_pages·integer
  • Pages available at this per_page.

per_page is capped at 100.

Each row is a summary. For one account's full status, its index readiness and the paragraph describing who that customer is, see GET /api_accounts/:uid.