Add a widget to a report page
Add a new widget to a report page at the specified grid position. widget_type must be one of: stat_card, line_chart, bar_chart, donut_chart, table, text. data_source identifies which SEO dataset powers the widget (e.g., ‘ranking_overview’, ‘backlink_summary’). Static widgets such as ‘text’ do not require a data_source.
curl --request POST \
--url https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"widget_type": "<string>",
"title": "<string>",
"data_source": "<string>",
"config": {},
"position_x": 0,
"position_y": 0,
"width": 1,
"height": 1
}
'import requests
url = "https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets"
payload = {
"widget_type": "<string>",
"title": "<string>",
"data_source": "<string>",
"config": {},
"position_x": 0,
"position_y": 0,
"width": 1,
"height": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
widget_type: '<string>',
title: '<string>',
data_source: '<string>',
config: {},
position_x: 0,
position_y: 0,
width: 1,
height: 1
})
};
fetch('https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'widget_type' => '<string>',
'title' => '<string>',
'data_source' => '<string>',
'config' => [
],
'position_x' => 0,
'position_y' => 0,
'width' => 1,
'height' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets"
payload := strings.NewReader("{\n \"widget_type\": \"<string>\",\n \"title\": \"<string>\",\n \"data_source\": \"<string>\",\n \"config\": {},\n \"position_x\": 0,\n \"position_y\": 0,\n \"width\": 1,\n \"height\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"widget_type\": \"<string>\",\n \"title\": \"<string>\",\n \"data_source\": \"<string>\",\n \"config\": {},\n \"position_x\": 0,\n \"position_y\": 0,\n \"width\": 1,\n \"height\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"widget_type\": \"<string>\",\n \"title\": \"<string>\",\n \"data_source\": \"<string>\",\n \"config\": {},\n \"position_x\": 0,\n \"position_y\": 0,\n \"width\": 1,\n \"height\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "<string>",
"title": "<string>",
"config": {},
"position_x": 123,
"position_y": 123,
"width": 123,
"height": 123,
"created_at": "2023-11-07T05:31:56Z",
"data_source": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
Request body for adding a new widget to a report page.
Type of widget to render. One of: stat_card, line_chart, bar_chart, donut_chart, table, text.
Display title shown in the widget header.
1 - 255Identifier for the data source powering this widget (e.g., 'ranking_overview', 'backlink_summary'). Null for static widgets such as 'text'.
Widget-specific configuration object (metrics to display, chart colours, table columns, text content, etc.).
Horizontal grid position (column index, 0-based).
Vertical grid position (row index, 0-based).
Width of the widget in grid columns (1–3).
1 <= x <= 3Height of the widget in grid rows (1–2).
1 <= x <= 2curl --request POST \
--url https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"widget_type": "<string>",
"title": "<string>",
"data_source": "<string>",
"config": {},
"position_x": 0,
"position_y": 0,
"width": 1,
"height": 1
}
'import requests
url = "https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets"
payload = {
"widget_type": "<string>",
"title": "<string>",
"data_source": "<string>",
"config": {},
"position_x": 0,
"position_y": 0,
"width": 1,
"height": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
widget_type: '<string>',
title: '<string>',
data_source: '<string>',
config: {},
position_x: 0,
position_y: 0,
width: 1,
height: 1
})
};
fetch('https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'widget_type' => '<string>',
'title' => '<string>',
'data_source' => '<string>',
'config' => [
],
'position_x' => 0,
'position_y' => 0,
'width' => 1,
'height' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets"
payload := strings.NewReader("{\n \"widget_type\": \"<string>\",\n \"title\": \"<string>\",\n \"data_source\": \"<string>\",\n \"config\": {},\n \"position_x\": 0,\n \"position_y\": 0,\n \"width\": 1,\n \"height\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"widget_type\": \"<string>\",\n \"title\": \"<string>\",\n \"data_source\": \"<string>\",\n \"config\": {},\n \"position_x\": 0,\n \"position_y\": 0,\n \"width\": 1,\n \"height\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/projects/{project_id}/reports/{report_id}/pages/{page_id}/widgets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"widget_type\": \"<string>\",\n \"title\": \"<string>\",\n \"data_source\": \"<string>\",\n \"config\": {},\n \"position_x\": 0,\n \"position_y\": 0,\n \"width\": 1,\n \"height\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"widget_type": "<string>",
"title": "<string>",
"config": {},
"position_x": 123,
"position_y": 123,
"width": 123,
"height": 123,
"created_at": "2023-11-07T05:31:56Z",
"data_source": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}