Skip to main content
POST
JavaScript

Authorizations

X-API-Key
string
header
required

Body

application/json
metrics
enum<string>[]
required

Metrics to include. share_of_voice is deprecated, use citation_share instead.

Available options:
count,
citation_share,
share_of_voice,
first_cited_at
category_id
string<uuid>
required
start_date
string<date-time>
required

Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

end_date
string<date-time>
required

End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

date_interval
enum<string>
default:day

Date interval for the report. (only used with date dimension)

Available options:
hour,
day,
week,
month,
quarter,
year,
relative_week
dimensions
enum<string>[]

Dimensions to group the report by.

Available options:
hostname,
path,
date,
region,
topic,
topic_id,
model,
tag,
prompt,
prompt_id,
url,
root_domain,
persona,
citation_category
order_by
Order By · object
Examples:
pagination
Pagination · object

Pagination settings for the report results.

filters
(HostnameFilter · object | PathFilter · object | RegionIdFilter · object | RegionNameFilter · object | TopicIdFilter · object | TopicNameFilter · object | ModelIdFilter · object | TagIdFilter · object | TagNameFilter · object | UrlFilter · object | RootDomainFilter · object | AnalysisTypeFilter · object | PromptTypeFilter · object | PersonaIdFilter · object | CitationCategoryFilter · object | PromptFilter · object | PromptIdFilter · object)[]

List of filters to apply to the citations report.

Filter by hostname

Response

Successful Response

info
Info · object
required

Base model for report information.

data
CitationsResult · object[]
required