Skip to main content
GET
Retrieve Citation Summary

Authorizations

X-Lightsage-Api-Key
string
header
required

Query Parameters

period
string

Named period, resolved in UTC by the server: last_7_days, last_14_days, last_30_days, last_90_days (N days ending today), this_week, last_week, an ISO week such as 2026-W43 (Monday to Sunday), this_month, last_month, a month such as 2026-10, this_quarter, last_quarter, or a quarter such as 2026Q4. A current week, month, or quarter ends today. The response's period gives the resolved dates and the matching previous period. Do not combine with start_date or end_date.

Maximum string length: 20
start_date
string<date>

Inclusive range start; defaults to 30 days before the end date. The range may span at most 90 days.

end_date
string<date>

Inclusive range end; defaults to today.

group_by
enum<string>
default:url_prefix

How to group citations.

Available options:
url_prefix,
url,
domain,
day
url_prefix
string

Only citations under this URL prefix, such as https://example.com/blog/. Scheme and www. are ignored.

Maximum string length: 500
source_type
enum<string>
default:all

All citations, only owned company domains, or only external ones.

Available options:
all,
owned,
external
platform
string

Optional answer-platform ID, name, or slug.

limit
integer
default:20

Groups to return; day groups return every day.

Required range: 1 <= x <= 100

Response

Successful Response

period
PublicResolvedPeriod · object
required

The resolved period and the previous period it is compared with.

group_by
enum<string>
required
Available options:
url_prefix,
url,
domain,
day
source_type
enum<string>
required
Available options:
all,
owned,
external
headline_metric
enum<string>
required

The number to lead with: citation counts when the periods are comparable, otherwise citations per run.

Available options:
citation_count,
citations_per_run
totals
PublicCitationSummaryTotals · object
required
has_data
boolean
required
group_count
integer
required

Groups matching the filters, before limit.

count
integer
required

Groups returned.

coverage
PublicCoverage · object
required

Runs per day against expected runs for both periods. Check comparable before comparing totals.

url_prefix
string | null

URL prefix filter applied, if any.

platform
string | null
groups
PublicCitationSummaryGroup · object[]

Groups by citation count, most first; day groups are in date order.