Skip to main content
GET
Get Reporting Experiment

Authorizations

Authorization
string
header
required

Unkey-issued API key

Path Parameters

experiment_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
experiment_type
enum<string>
required
Available options:
visibility,
sentiment
experiment_sub_type
enum<string>
required
Available options:
discovery,
informational,
competitor_alternatives,
competitor_comparison,
brand_sentiment
company_name
string
required
company_domain
string
required
company_aliases
string[] | null
required
description
string
required
category_map
Category Map · object
required
models
string[]
required
organization_id
string
required
created_by
string
required
is_archived
boolean
required
is_pinned
boolean
required
query_set_id
string<uuid> | null
tags
string[] | null
country
string | null
Pattern: ^\w{2}$
region
string | null
city
string | null
schedule_id
string<uuid> | null
config
Config · object | null
first_execution_created_at
string<date-time> | null
last_execution_created_at
string<date-time> | null
schedule
ScheduleRead · object | null