Skip to main content
POST
Add a widget

Path Parameters

projectId
string<uuid>
required
reportId
string<uuid>
required
pageId
string<uuid>
required

Body

application/json
widget_type
enum<string>
required
Available options:
stat_card,
line_chart,
bar_chart,
donut_chart,
table,
text
title
string
required
Required string length: 1 - 200
data_source
enum<string>
Available options:
tracking.overview,
tracking.changes,
tracking.history,
backlinks.summary,
backlinks.history,
backlinks.anchors,
audit.summary,
audit.issues,
audit.pages,
geo.overview,
geo.trend,
geo.topics,
web_vitals.latest,
local.overview,
domain.overview
config
object
position_x
integer
default:0
Required range: x >= 0
position_y
integer
default:0
Required range: x >= 0
width
integer
default:1
Required range: 1 <= x <= 4
height
integer
default:1
Required range: 1 <= x <= 4

Response

200 - application/json

The report

success
enum<boolean>
required
Available options:
true
data
object | null
required