Skip to main content
GET
Average Position Over Time

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required
workspace_id
string
required
project_id
string
required

Query Parameters

metric_type
enum<string>
default:domain
Available options:
domain,
citation
date_start
string<date>
required

Start of the date range (YYYY-MM-DD).

date_end
string<date>
required

End of the date range (YYYY-MM-DD, inclusive).

sources
enum<string>[] | null
Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus,
Grok,
Copilot,
Mistral
thematics
string<uuid>[] | null

Filter by a list of thematic IDs

keyword_type
enum<string>[] | null

Filter by a list of keyword types

Available options:
Generic,
Brand
funnel_stages
enum<string>[] | null

Filter by a list of Funnel Stages

Available options:
ToFu,
MoFu,
BoFu
persona_ids
string[] | null

Filter by a list of persona IDs

topic_ids
string[] | null

Filter by a list of topic IDs

get_neutrals
boolean | null

Filter by to get results related to neutral prompts, without weakness or strength

strength_ids
string[] | null

Filter by a list of strength IDs

weakness_ids
string[] | null

Filter by a list of weakness IDs

Response

Successful Response

collection_date
string
required

Collection date in YYYY-MM-DD format.

metric_type
enum<string>
required
Available options:
domain,
citation
value
Metric · object
required

Rounded average best position across selected engines. Zero means no positions.