Skip to content
recomentionrecomentionrecomention docs

Get a report

GET
/v1/reports/{slug}
curl --request GET \
  --url https://api.recomention.com/v1/reports/example \
  --header 'Authorization: Bearer <token>'

The full report as JSON: scores, competitors, sources, the fix list and every answer. Only the owner’s key can read it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Responses

Section titled “Responses”

200

Section titled “200”

The report.

Media typeapplication/json
object
report
required
object
slug
required
string
url
required

The report page.

string
status
required
string
Allowed values: PENDING RUNNING COMPLETE FAILED
simulated
required

A test run with made-up answers. Draw no conclusions from it.

boolean
plan
required
string
funding
required
Any of:
string
Allowed value: BYOK
overallScore
required
Any of:
number
createdAt
required
string format: date-time
completedAt
required
Any of:
string format: date-time
brand
required
string
domain
required
string
category
required
string
progress
required
Any of:
object
answersStored
required
integer
>= -9007199254740991 <= 9007199254740991
answersPlanned
required
integer
>= -9007199254740991 <= 9007199254740991
error
required
Any of:
string
description
required
string
preparedBy
required
Any of:
string
paid
required
boolean
summary
required
Any of:
string
engines
required
Array<object>
object
engine
required

An answer engine.

string
Allowed values: OPENAI ANTHROPIC PERPLEXITY GEMINI GROK AI_OVERVIEW
label
required
string
mentionRate
required
number
runsMentioned
required
integer
>= -9007199254740991 <= 9007199254740991
runsTotal
required
integer
>= -9007199254740991 <= 9007199254740991
runsNoAnswer
required
integer
>= -9007199254740991 <= 9007199254740991
promptsMentioned
required
integer
>= -9007199254740991 <= 9007199254740991
promptsTotal
required
integer
>= -9007199254740991 <= 9007199254740991
avgRank
required
Any of:
number
badgeEarned
required
boolean
enginesSkipped
required

Engines that did not run, and why. Never scored as zero.

Array<object>
object
engine
required

An answer engine.

string
Allowed values: OPENAI ANTHROPIC PERPLEXITY GEMINI GROK AI_OVERVIEW
label
required
string
reason
required
string
competitors
required
Array<object>
object
brand
required
string
domain
string
shareOfVoice
required
number
mentions
required
integer
>= -9007199254740991 <= 9007199254740991
avgRank
required
Any of:
number
sources
required
Array<object>
object
domain
required
string
citations
required
integer
>= -9007199254740991 <= 9007199254740991
engines
required
Array<string>
Allowed values: OPENAI ANTHROPIC PERPLEXITY GEMINI GROK AI_OVERVIEW
exampleUrl
required
string
own
boolean
actionPlan
required
Array<object>
object
title
required
string
why
required
string
how
required
string
effort
required
string
Allowed values: low medium high
questions
required
Array<object>
object
order
required
integer
>= -9007199254740991 <= 9007199254740991
text
required
string
intent
required
string
stage
string
answers
required
Array<object>
object
engine
required

An answer engine.

string
Allowed values: OPENAI ANTHROPIC PERPLEXITY GEMINI GROK AI_OVERVIEW
run
required
integer
>= -9007199254740991 <= 9007199254740991
failed
required

The call failed. A failed call is in no count — never a run that did not mention the product.

boolean
failure
required
Any of:
string
noAnswer
required
Any of:
string
mentioned
required
Any of:
boolean
rank
required
Any of:
number
brands
required
Array<object>
object
name
required
string
domain
string
citations
required
Array<object>
object
url
required
string
domain
required
string
title
string
answer
required
Any of:
string

Example 

{
  "report": {
    "status": "PENDING",
    "funding": "BYOK",
    "engines": [
      {
        "engine": "OPENAI"
      }
    ],
    "enginesSkipped": [
      {
        "engine": "OPENAI"
      }
    ],
    "sources": [
      {
        "engines": [
          "OPENAI"
        ]
      }
    ],
    "actionPlan": [
      {
        "effort": "low"
      }
    ],
    "questions": [
      {
        "answers": [
          {
            "engine": "OPENAI"
          }
        ]
      }
    ]
  }
}

401

Section titled “401”

Missing, malformed, unknown or revoked API key.

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"
}

404

Section titled “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

Section titled “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

Section titled “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.

503

Section titled “503”

A dependency is briefly unavailable. Retry after 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

Section titled “Headers”
Retry-After
integer

Seconds to wait.

recomention.comStatussupport@recomention.com