API Reference
Read a compact business overview
Permission-aware orientation for the authenticated connected business. No new grant scope is required: each section independently requires its existing read scope. Identity is authenticated business metadata; missing permissions, unavailable data, incomplete inventories and timestamps are explicit. refresh=true bypasses the 60-second bounded cache. Activity uses tenant-local last_30d. Saved configuration and capability readiness are not live provider health, execution authorization, or delivery/booking proof. No tenant/admin override, provider calls, transcripts, prompts, schemas or credentials. Use detailed inspection tools for follow-up and fresh checks before actions. This helper adds no Lana action debit.
GET
/
business
/
overview
Read a compact business overview
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/business/overviewimport requests
url = "https://platform-api.visitoai.com/m2m/v1/business/overview"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://platform-api.visitoai.com/m2m/v1/business/overview', 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://platform-api.visitoai.com/m2m/v1/business/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://platform-api.visitoai.com/m2m/v1/business/overview"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/business/overview")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/business/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"version": 1,
"generatedAt": "2023-11-07T05:31:56Z",
"business": {
"tenantId": "<string>",
"name": "<string>",
"timezone": "<string>",
"locale": "<string>",
"useCases": [
"<string>"
],
"observedAt": "2023-11-07T05:31:56Z"
},
"cache": {
"hit": true,
"expiresAt": "2023-11-07T05:31:56Z"
},
"complete": true,
"sections": {
"properties": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"channels": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"integrationsActions": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"knowledge": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"automation": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"crm": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"offerings": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"activity": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"attention": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
}
},
"topBlockers": [
{
"section": "properties",
"code": "<string>",
"resourceId": "<string>",
"inspectionTool": "<string>",
"integrationId": "<string>"
}
]
}Query Parameters
Bypass cached summaries after configuration changes. Defaults to false.
Response
Compact overview; sections can independently be unavailable or unauthorized.
Available options:
1 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
5Show child attributes
Show child attributes
⌘I
Read a compact business overview
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/business/overviewimport requests
url = "https://platform-api.visitoai.com/m2m/v1/business/overview"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://platform-api.visitoai.com/m2m/v1/business/overview', 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://platform-api.visitoai.com/m2m/v1/business/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://platform-api.visitoai.com/m2m/v1/business/overview"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/business/overview")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/business/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"version": 1,
"generatedAt": "2023-11-07T05:31:56Z",
"business": {
"tenantId": "<string>",
"name": "<string>",
"timezone": "<string>",
"locale": "<string>",
"useCases": [
"<string>"
],
"observedAt": "2023-11-07T05:31:56Z"
},
"cache": {
"hit": true,
"expiresAt": "2023-11-07T05:31:56Z"
},
"complete": true,
"sections": {
"properties": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"channels": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"integrationsActions": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"knowledge": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"automation": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"crm": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"offerings": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"activity": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
},
"attention": {
"state": "available",
"observedAt": "2023-11-07T05:31:56Z",
"complete": true,
"data": {},
"reason": "<string>"
}
},
"topBlockers": [
{
"section": "properties",
"code": "<string>",
"resourceId": "<string>",
"inspectionTool": "<string>",
"integrationId": "<string>"
}
]
}