List session visualizations
curl --request GET \
--url https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations', 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.roofkit.ai/api/v1/sessions/{session_id}/visualizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"visualizations": [
{
"id": "<string>",
"session_id": "<string>",
"source": "sales_visualizer",
"landing_id": "<string>",
"landing_name": "<string>",
"landing_slug": "<string>",
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"original_image_url": "<string>",
"processed_image_url": "<string>",
"processing_status": "pending",
"processing_started_at": "2023-11-07T05:31:56Z",
"processing_completed_at": "2023-11-07T05:31:56Z",
"processing_error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 5000,
"next_cursor": "<string>",
"has_more": true,
"total": 1
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "API key does not include the required scope: leads.write.",
"request_id": "req_123",
"details": {
"required_scope": "leads.write",
"missing_scopes": [
"leads.write"
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Visualizer
List session visualizations
Lists Sales Visualizer rows for a session, including pending, processing, failed, and completed states.
GET
/
api
/
v1
/
sessions
/
{session_id}
/
visualizations
List session visualizations
curl --request GET \
--url https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations', 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.roofkit.ai/api/v1/sessions/{session_id}/visualizations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roofkit.ai/api/v1/sessions/{session_id}/visualizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"visualizations": [
{
"id": "<string>",
"session_id": "<string>",
"source": "sales_visualizer",
"landing_id": "<string>",
"landing_name": "<string>",
"landing_slug": "<string>",
"selected_material_id": "<string>",
"selected_color_id": "<string>",
"selected_shape_id": "<string>",
"original_image_url": "<string>",
"processed_image_url": "<string>",
"processing_status": "pending",
"processing_started_at": "2023-11-07T05:31:56Z",
"processing_completed_at": "2023-11-07T05:31:56Z",
"processing_error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 5000,
"next_cursor": "<string>",
"has_more": true,
"total": 1
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "FORBIDDEN",
"message": "API key does not include the required scope: leads.write.",
"request_id": "req_123",
"details": {
"required_scope": "leads.write",
"missing_scopes": [
"leads.write"
]
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Required scopes:
sales_visualizer.useAuthorizations
Use Authorization: Bearer rk_live_....
Path Parameters
Required string length:
1 - 500Query Parameters
Opaque cursor returned by list/export responses. Send it back unchanged; malformed cursors return 400.
Maximum string length:
500Required range:
1 <= x <= 100