v1
In-guide features

Get the latest information gain analysis of a guide

Réservé : en test, accès sur invitation. Reserved feature, in test, access by invitation. Accounts without access receive 403 FEATURE_NOT_AVAILABLE.

Returns the latest analysis of the guide, whatever its status. While status is pending or running, call again every 10 seconds (an analysis takes 30 to 60 seconds, a recheck about 10 seconds).

view=summary (default, read it first) is built for an agent. score is the coverage of the consensus, from 0 to 100, or null when nothing is measurable (never 0 by default). The consensus is the facts stated by at least 2 distinct sites among the top pages (a site is a registrable domain, so two pages of the same domain or of its subdomains count as one site), and each consensus fact weighs its number of sites in the score. missing lists the consensus facts absent from the text, partial the ones stated only in part (with what is missing), both sorted by number of sites, then number of pages, then best position. single lists the facts stated by one site only and not covered (outside the score). leads are facts found beyond the top results, questions are first-hand questions only the author can answer. covered lists the consensus facts the text already states, and unknown the consensus facts with no verdict on the text yet (outside the score). sites lists the distinct sites among the top pages read, one per site with its best ranked page (url, position) and its number of pages read, sorted by position. Each source carries the key of its site, the same as in sites, so a fact can be laid out site by site. counts has one scope, the consensus (consensus, covered, partial, missing, unknown), plus single, the length of the single list. Only the pages read from the top results count as pages or sites of a fact. Every fact carries pages and pagesTotal (pages that state it, pages read), sites and sitesTotal (distinct sites that state it, distinct sites among the pages read), its sources, one per page (url, position, verbatim excerpt), and the verdict on the guide text (status, excerpt, missing). Every fact also carries scoreGain, the points the score would gain if the text fully stated it, all else being equal, max(1, round(100 x sites x (1 - c) / total)), c being 0 for absent and 0.5 for partial, total the sum of sites of the consensus facts with a known verdict (the denominator of score). scoreGain is null for any other fact (covered, unknown, outside the consensus), never 0, and since every positive gain counts at least 1, the gains may add up to more than 100 minus score, so never sum them. textSource is request as soon as SERPmantics sent the text to check (htmlContent, or the saved text read when the call was made), saved when the analysis service read the saved text itself (older analyses), and null while status is pending or running, or when a failed analysis did not record it (unknown source). textHash is the fingerprint of the text actually read. sitesRead is the number of distinct sites among the top pages read (same rule as sitesTotal), null when no top page was read. limits flags partial measures, and limits.issues lists each partial failure as a stable code (leads_untriaged, source_check_partial, cross_check_partial, questions_failed, coverage_partial, coverage_no_answer, excerpts_rejected) with failed and total when known. excerpts_rejected also carries undecided, the items the check left undecided for any reason; when it equals failed, checking again would not settle them.

view=full returns the whole normalized document (full matrix of topics, facts and sources, pages read and skipped with their reason, statistics).

Reading is free. When the analysis ended failed after being launched (or the last recheck ended without a new verdict, the analysis being done again with only its error set), the tokens charged for it are given back once, at the first read that sees it. The response then carries refunded (true when the credit is on the ledger, false when the refund failed and will be tried again at a later read) and refundedTokens, for the account that was charged. Both fields are absent when nothing was given back, or when the reader is not the charged account (the tokens still go back to it).

get/api/v1/information-gain

Request

  • Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.serpmantics.com/api/v1/information-gain
  • Auth: HTTP bearer

Query parameters

guideIdstring required

ID of the guide (24 hexadecimal characters).

view'summary' | 'full'

summary (default) for the scored, sorted lists; full for the whole matrix.

Response

The analysis, as a summary (view=summary) or as the full normalized document (view=full).

successboolean
refundedboolean

Present only when the analysis (or its last recheck) failed after being launched and charged. true when its tokens were given back, false when the refund failed (tried again at the next read).

refundedTokensinteger

Tokens given back (or to give back), present with refunded.

Example response

{
  "success": true,
  "refundedTokens": 60,
  "data": {
    "progress": {
      "done": 3,
      "total": 7
    },
    "score": 75,
    "counts": {
      "consensus": 8,
      "covered": 5,
      "partial": 2,
      "missing": 1,
      "single": 40
    },
    "missing": [
      {
        "scoreGain": 10
      }
    ],
    "partial": [
      {
        "scoreGain": 5
      }
    ],
    "sitesRead": 7
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.