Skip to content
Documentation/Numbers

Compare figures

Recompute and compare figures you already extracted.

Markdown
POST/api/v1/analyze/conflictshttps://api.webcite.co

When to use it

Compare figures only when entity, period, unit, currency, scale, basis, and definition are compatible. Include source-linked fxRates for currency conversion and reviewed precedenceRules only where justified. A missing comparison is not a clean result.

Request

1 credit.

Examples run on your server. Set WEBCITE_API_KEY first. Python examples use the requests package.

curl
curl --fail-with-body -X POST 'https://api.webcite.co/api/v1/analyze/conflicts' \
  -H "x-api-key: $WEBCITE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "figures": [
    {
      "metric": "revenue",
      "value": 12,
      "unit": "currency",
      "currency": "USD",
      "period": "FY2025",
      "decimalValue": "12",
      "provenance": {
        "assetId": "YOUR_ASSET_ID",
        "sheet": "Income statement",
        "cell": "B2",
        "documentName": "Example annual report",
        "method": "rule"
      }
    }
  ]
}'

Request body

figuresobject[]required

Figures extracted across one or more documents. The engine groups compatible entities, periods, currencies, scales, bases and definitions, recomputes derivable metrics, and reports conflicts or unavailable comparisons.

Show figures fields
basisstring

Whether the figure is actual, forecast, assumed or unknown.

Values: "actual""forecast""assumption""unknown"

currencystring

Currency code of the normalized value.

decimalValuestring

Canonical decimal text used for exact arithmetic. Without it the figure can be reported but not recomputed.

definitionstring

Definition or accounting-policy scope.

entitystring

Entity scope, e.g. "subscription".

metricstringrequired

Metric dictionary key, e.g. "gross_margin".

observationIdstring

Immutable observation identity. Exact replay may reuse it.

periodstring

Period, e.g. "FY2024".

provenanceobjectrequired
Show provenance fields
assetIdstringrequired

Asset the figure came from.

cellstring

Cell reference, e.g. B4.

documentNamestringrequired

Human-readable document name.

methodstringrequired

How the value was extracted.

Values: "rule""model"

pagenumber

1-based page.

sheetstring

Sheet name.

scalestring

Scale qualifier for the already-normalized value. This does not apply another conversion.

unitstringrequired

Canonical unit.

Values: "percent""multiple""currency""ratio""count""months"

valuenumberrequired

Value normalized to the metric canonical unit.

fxRatesobject[]

Source-linked FX observations. A rate is used only for its exact applicable period and declared conversion direction.

Show fxRates fields
applicableDatestringrequired
applicablePeriodstringrequired
decimalRatestringrequired

Canonical decimal rate used by exact arithmetic.

directionstringrequired

Values: "multiply""divide"

fromCurrencystringrequired
idstringrequired
provenanceobjectrequired
Show provenance fields
assetIdstringrequired

Asset the figure came from.

cellstring

Cell reference, e.g. B4.

documentNamestringrequired

Human-readable document name.

methodstringrequired

How the value was extracted.

Values: "rule""model"

pagenumber

1-based page.

sheetstring

Sheet name.

ratenumberrequired
ruleRevisionstringrequired
toCurrencystringrequired
precedenceRulesobject[]

Reviewed, scope-exact decisions that select one observation and enumerate every superseded competing identity.

Show precedenceRules fields
basisstringrequired

Values: "actual""forecast""assumption""unknown"

currencystringrequired
definitionstringrequired
entitystringrequired
idstringrequired
metricstringrequired
periodstringrequired
provenanceobjectrequired
Show provenance fields
assetIdstringrequired

Asset the figure came from.

cellstring

Cell reference, e.g. B4.

documentNamestringrequired

Human-readable document name.

methodstringrequired

How the value was extracted.

Values: "rule""model"

pagenumber

1-based page.

sheetstring

Sheet name.

reasonstringrequired
reviewerIdstringrequired
ruleRevisionstringrequired
scalestringrequired
selectedObservationIdstringrequired
supersededObservationIdsstring[]required

Response

Returns conflicts, recomputations, and review information. The current public schema describes the request figures but does not define the complete response.

200 response

See the response guidance above. A complete JSON schema is not published for this response.

Errors

For 400, check the request fields and source identifiers. For 401, check your API key. For 429, wait for the retry interval. See the errors guide before retrying a billable request.

401
Unauthorized - API key required
429
Rate limit exceeded
Error handling and retry guidance