Skip to main content
POST
Estimate an export

Authorizations

Authorization
string
header
required

Your API key. Create one in Settings, API keys. Send it as Authorization: Bearer rk_live_YOUR_KEY.

Path Parameters

project
string
required

The project id. 24 characters. From List projects.

Pattern: ^[0-9a-f]{24}$

Body

application/json
type
enum<string>
required

What to export. responses is one row per AI answer with brand mention, position, sentiment, competitors, sources cited and the answer as Markdown. sources is one row per page cited or consulted. competitors is one row per competitor named. rankings is one row per recommended domain with its position. query_fanout is one row per search query the model ran.

Available options:
responses,
sources,
competitors,
rankings,
query_fanout
format
enum<string>
default:csv

csv with a header row, or ndjson with one JSON object per line.

Available options:
csv,
ndjson
from
string<date>

First day, YYYY-MM-DD. Default: 30 days ago.

to
string<date>

Last day, YYYY-MM-DD, included. Default: today.

models
string[]

Models to include. Default: every model the project tracks.

Maximum array length: 10
topic_ids
integer[]

Every active prompt in these topics.

Maximum array length: 100
prompt_ids
integer[]

Only these prompts. Leave both this and topic_ids out to export every prompt.

Maximum array length: 500
include_answer
boolean
default:true

responses only. Set false to leave the answer text out and get a much smaller file.

Response

The normalised plan and the estimate.

data
object
meta
object
credits
object

What this call cost and what is left. Also in the X-RadarKit-Credits-Charged and X-RadarKit-Credits-Remaining headers.

request_id
string

A unique id for this call. Also in the X-Request-Id header. Quote it when you contact support.

Example:

"req_01j9x4m2p7q8r9s0t1u2v3w4x5"