AI Index

AI Recommendation Index — category rankings

Per-category recommendation share, average position, per-engine breakdown and 4-week trend for every product AI engines recommend in the category. Categories with fewer runs than the minimum sample return status "insufficient_data" instead of noisy numbers.

get/api/index/{slug}

Request

  • Base URL: https://api.orbator.io
  • URL: https://api.orbator.io/api/index/{slug}
  • Auth: one of:
    • none
    • API key in header X-Api-Key
    • HTTP bearer

Path parameters

slugstring required

Category slug, e.g. crm-for-freelancers

Query parameters

by_intent'1'

Set to 1 to include intent_shares: recommendation shares grouped by the buyer prompt's intent (best_in_category, alternatives, problem_solving, ...). Omitted otherwise.

Response

Category index payload (share, trend, per-engine breakdown, sample size, methodology URL)

status'ok' | 'insufficient_data'
sample_sizeinteger

Answer runs in the current window

prior_sample_sizeinteger
min_sampleinteger

Runs required before numbers are published

engine_samplesobject

Per-engine audit trail (MTH-006): current-window run counts (they sum to sample_size) plus each engine's newest run date across the current + prior windows — rotation lag is disclosed, not hidden.

methodology_urlstring
licensestring

Example response

{
  "window": {
    "weeks": 4
  }
}

Changes

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