Get one ranking

GET

/v1/rankings/{slug}

curl --request GET \
  --url https://api.recomention.com/v1/rankings/example

One category’s latest ranking with every answer verbatim. No key needed.

Parameters

Path Parameters

slug

required

string

Responses

200

The ranking.

Media typeapplication/json

object

ranking

required

object

version

required

integer

>= -9007199254740991 <= 9007199254740991

slug

required

string

category

required

string

month

required

string

checkedAt

required

string format: date-time

engines

required

Array<string>

Allowed values: OPENAI ANTHROPIC PERPLEXITY GEMINI GROK AI_OVERVIEW

runsPerPrompt

required

integer

>= -9007199254740991 <= 9007199254740991

prompts

required

Array<object>

object

text

required

string

key

additional properties

brands

required

Array<object>

object

name

required

string

domain

string

mentions

required

integer

>= -9007199254740991 <= 9007199254740991

avgPosition

required

number

key

additional properties

answers

required

Array<object>

object

prompt

required

integer

>= -9007199254740991 <= 9007199254740991

engine

required

An answer engine.

string

Allowed values: OPENAI ANTHROPIC PERPLEXITY GEMINI GROK AI_OVERVIEW

run

required

integer

>= -9007199254740991 <= 9007199254740991

text

required

string

key

additional properties

url

required

string

key

additional properties

Example

{
  "ranking": {
    "engines": [
      "OPENAI"
    ],
    "answers": [
      {
        "engine": "OPENAI"
      }
    ]
  }
}

404

Not found. Someone else’s report answers the same as a missing one.

Media typeapplication/json

object

error

required

What went wrong, in plain words. Never repeats a submitted secret.

string

fields

Request fields to fix (400).

Array<string>

retryAfterSeconds

Seconds to wait before retrying (429).

integer

>= -9007199254740991 <= 9007199254740991

limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string

status

The report’s status, when it explains the refusal (409).

string

Example ^generated

{
  "error": "example",
  "fields": [
    "example"
  ],
  "retryAfterSeconds": 1,
  "limit": "example",
  "status": "example"
}

429

Rate limited. Wait Retry-After seconds.

Media typeapplication/json

object

error

required

What went wrong, in plain words. Never repeats a submitted secret.

string

fields

Request fields to fix (400).

Array<string>

retryAfterSeconds

Seconds to wait before retrying (429).

integer

>= -9007199254740991 <= 9007199254740991

limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string

status

The report’s status, when it explains the refusal (409).

string

Example ^generated

{
  "error": "example",
  "fields": [
    "example"
  ],
  "retryAfterSeconds": 1,
  "limit": "example",
  "status": "example"
}

Headers

Retry-After

integer

Seconds to wait.

RateLimit-Limit

integer

Requests allowed in the window.

RateLimit-Remaining

integer

Requests left in the window (0 on a 429).

RateLimit-Reset

integer

Seconds until the window resets.