Orgs Pages
Add a block
Add a block to a page. Only the type is required; data blocks can be pointed at a table or view later.
POST
/
orgs
/
{org_id}
/
pages
/
{page_ref}
/
blocks
Add a block
curl --request POST \
--url https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"shared": {},
"heading": {
"text": "<string>",
"level": 1
},
"text": {
"markdown": "<string>"
},
"stat": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period"
},
"chart": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"limit": 25
},
"table": {
"limit": 25
},
"pages": {
"page_ids": [
"<string>"
]
}
},
"table_id": "<string>",
"view_id": "<string>",
"after": "<string>",
"before": "<string>"
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks"
payload = {
"config": {
"shared": {},
"heading": {
"text": "<string>",
"level": 1
},
"text": { "markdown": "<string>" },
"stat": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period"
},
"chart": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"limit": 25
},
"table": { "limit": 25 },
"pages": { "page_ids": ["<string>"] }
},
"table_id": "<string>",
"view_id": "<string>",
"after": "<string>",
"before": "<string>"
}
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({
config: {
shared: {},
heading: {text: '<string>', level: 1},
text: {markdown: '<string>'},
stat: {
label: '<string>',
filter: {type: 'rule', key: '<string>', value: '<unknown>'},
compare: 'previous_period'
},
chart: {
label: '<string>',
filter: {type: 'rule', key: '<string>', value: '<unknown>'},
limit: 25
},
table: {limit: 25},
pages: {page_ids: ['<string>']}
},
table_id: '<string>',
view_id: '<string>',
after: '<string>',
before: '<string>'
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks', 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.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks",
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([
'config' => [
'shared' => [
],
'heading' => [
'text' => '<string>',
'level' => 1
],
'text' => [
'markdown' => '<string>'
],
'stat' => [
'label' => '<string>',
'filter' => [
'type' => 'rule',
'key' => '<string>',
'value' => '<unknown>'
],
'compare' => 'previous_period'
],
'chart' => [
'label' => '<string>',
'filter' => [
'type' => 'rule',
'key' => '<string>',
'value' => '<unknown>'
],
'limit' => 25
],
'table' => [
'limit' => 25
],
'pages' => [
'page_ids' => [
'<string>'
]
]
],
'table_id' => '<string>',
'view_id' => '<string>',
'after' => '<string>',
'before' => '<string>'
]),
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.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks"
payload := strings.NewReader("{\n \"config\": {\n \"shared\": {},\n \"heading\": {\n \"text\": \"<string>\",\n \"level\": 1\n },\n \"text\": {\n \"markdown\": \"<string>\"\n },\n \"stat\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\"\n },\n \"chart\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n },\n \"table\": {\n \"limit\": 25\n },\n \"pages\": {\n \"page_ids\": [\n \"<string>\"\n ]\n }\n },\n \"table_id\": \"<string>\",\n \"view_id\": \"<string>\",\n \"after\": \"<string>\",\n \"before\": \"<string>\"\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.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"shared\": {},\n \"heading\": {\n \"text\": \"<string>\",\n \"level\": 1\n },\n \"text\": {\n \"markdown\": \"<string>\"\n },\n \"stat\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\"\n },\n \"chart\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n },\n \"table\": {\n \"limit\": 25\n },\n \"pages\": {\n \"page_ids\": [\n \"<string>\"\n ]\n }\n },\n \"table_id\": \"<string>\",\n \"view_id\": \"<string>\",\n \"after\": \"<string>\",\n \"before\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks")
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 \"config\": {\n \"shared\": {},\n \"heading\": {\n \"text\": \"<string>\",\n \"level\": 1\n },\n \"text\": {\n \"markdown\": \"<string>\"\n },\n \"stat\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\"\n },\n \"chart\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n },\n \"table\": {\n \"limit\": 25\n },\n \"pages\": {\n \"page_ids\": [\n \"<string>\"\n ]\n }\n },\n \"table_id\": \"<string>\",\n \"view_id\": \"<string>\",\n \"after\": \"<string>\",\n \"before\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "block_5Fb7…",
"page_id": "page_5Fb7…",
"config": {
"shared": {},
"heading": {
"text": "<string>",
"level": 1
},
"text": {
"markdown": "<string>"
},
"stat": {
"label": "<string>",
"metric": {
"field_key": "<string>"
},
"window": {
"field_key": "<string>"
},
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period"
},
"chart": {
"label": "<string>",
"metric": {
"field_key": "<string>"
},
"group_by": {
"field_key": "<string>"
},
"window": {
"field_key": "<string>"
},
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"limit": 25
},
"table": {
"limit": 25
},
"pages": {
"page_ids": [
"<string>"
]
}
},
"table_id": "<string>",
"view_id": "<string>",
"position": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Bearer token authentication using your API key
Body
application/jsonmultipart/form-data
Response
200 - application/json
Example:
"block_5Fb7…"
Example:
"page_5Fb7…"
Available options:
heading, text, stat, chart, table, pages Show child attributes
Show child attributes
Source table for data blocks. Null when the table was deleted.
Embedded view for table blocks. Null when the view was deleted.
Fractional order within the page.
Was this page helpful?
⌘I
Add a block
curl --request POST \
--url https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"shared": {},
"heading": {
"text": "<string>",
"level": 1
},
"text": {
"markdown": "<string>"
},
"stat": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period"
},
"chart": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"limit": 25
},
"table": {
"limit": 25
},
"pages": {
"page_ids": [
"<string>"
]
}
},
"table_id": "<string>",
"view_id": "<string>",
"after": "<string>",
"before": "<string>"
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks"
payload = {
"config": {
"shared": {},
"heading": {
"text": "<string>",
"level": 1
},
"text": { "markdown": "<string>" },
"stat": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period"
},
"chart": {
"label": "<string>",
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"limit": 25
},
"table": { "limit": 25 },
"pages": { "page_ids": ["<string>"] }
},
"table_id": "<string>",
"view_id": "<string>",
"after": "<string>",
"before": "<string>"
}
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({
config: {
shared: {},
heading: {text: '<string>', level: 1},
text: {markdown: '<string>'},
stat: {
label: '<string>',
filter: {type: 'rule', key: '<string>', value: '<unknown>'},
compare: 'previous_period'
},
chart: {
label: '<string>',
filter: {type: 'rule', key: '<string>', value: '<unknown>'},
limit: 25
},
table: {limit: 25},
pages: {page_ids: ['<string>']}
},
table_id: '<string>',
view_id: '<string>',
after: '<string>',
before: '<string>'
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks', 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.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks",
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([
'config' => [
'shared' => [
],
'heading' => [
'text' => '<string>',
'level' => 1
],
'text' => [
'markdown' => '<string>'
],
'stat' => [
'label' => '<string>',
'filter' => [
'type' => 'rule',
'key' => '<string>',
'value' => '<unknown>'
],
'compare' => 'previous_period'
],
'chart' => [
'label' => '<string>',
'filter' => [
'type' => 'rule',
'key' => '<string>',
'value' => '<unknown>'
],
'limit' => 25
],
'table' => [
'limit' => 25
],
'pages' => [
'page_ids' => [
'<string>'
]
]
],
'table_id' => '<string>',
'view_id' => '<string>',
'after' => '<string>',
'before' => '<string>'
]),
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.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks"
payload := strings.NewReader("{\n \"config\": {\n \"shared\": {},\n \"heading\": {\n \"text\": \"<string>\",\n \"level\": 1\n },\n \"text\": {\n \"markdown\": \"<string>\"\n },\n \"stat\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\"\n },\n \"chart\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n },\n \"table\": {\n \"limit\": 25\n },\n \"pages\": {\n \"page_ids\": [\n \"<string>\"\n ]\n }\n },\n \"table_id\": \"<string>\",\n \"view_id\": \"<string>\",\n \"after\": \"<string>\",\n \"before\": \"<string>\"\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.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"shared\": {},\n \"heading\": {\n \"text\": \"<string>\",\n \"level\": 1\n },\n \"text\": {\n \"markdown\": \"<string>\"\n },\n \"stat\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\"\n },\n \"chart\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n },\n \"table\": {\n \"limit\": 25\n },\n \"pages\": {\n \"page_ids\": [\n \"<string>\"\n ]\n }\n },\n \"table_id\": \"<string>\",\n \"view_id\": \"<string>\",\n \"after\": \"<string>\",\n \"before\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/pages/{page_ref}/blocks")
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 \"config\": {\n \"shared\": {},\n \"heading\": {\n \"text\": \"<string>\",\n \"level\": 1\n },\n \"text\": {\n \"markdown\": \"<string>\"\n },\n \"stat\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\"\n },\n \"chart\": {\n \"label\": \"<string>\",\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n },\n \"table\": {\n \"limit\": 25\n },\n \"pages\": {\n \"page_ids\": [\n \"<string>\"\n ]\n }\n },\n \"table_id\": \"<string>\",\n \"view_id\": \"<string>\",\n \"after\": \"<string>\",\n \"before\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "block_5Fb7…",
"page_id": "page_5Fb7…",
"config": {
"shared": {},
"heading": {
"text": "<string>",
"level": 1
},
"text": {
"markdown": "<string>"
},
"stat": {
"label": "<string>",
"metric": {
"field_key": "<string>"
},
"window": {
"field_key": "<string>"
},
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period"
},
"chart": {
"label": "<string>",
"metric": {
"field_key": "<string>"
},
"group_by": {
"field_key": "<string>"
},
"window": {
"field_key": "<string>"
},
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"limit": 25
},
"table": {
"limit": 25
},
"pages": {
"page_ids": [
"<string>"
]
}
},
"table_id": "<string>",
"view_id": "<string>",
"position": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}