Skip to main content
GET
Citations over time

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>.

Path Parameters

id
string
required

Query Parameters

days
enum<integer>
default:30

Window length ending now. When since and until are set, the fixed window wins and days is only echoed as windowDays.

Available options:
7,
30,
90
since
string<date-time>

Inclusive ISO instant with a timezone offset. Requires until.

until
string<date-time>

Exclusive ISO instant with a timezone offset. Requires since.

engine
string

Same filter as the report.

prompt
string

Same exact-prompt filter as the report.

Maximum string length: 2000
kind
enum<string>
default:all

Narrows the domains and pages lists to one source type.

Available options:
all,
owned,
editorial,
review_media,
pr_wire,
institution,
reviews,
commerce,
social,
blog,
community,
video,
brand,
content,
other
q
string

Substring filter: domain name in the domains list, URL in the pages list.

Maximum string length: 200
offset
integer
default:0

Skips this many rows in each list. Each list returns 20 rows.

Required range: 0 <= x <= 10000

Response

Citation totals, daily series and ranked sources.

success
boolean
data
object