Create Guide
curl --request POST \
--url https://dash.tinyanalytics.io/api/sites/{site}/guides \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Get started checklist",
"type": "checklist",
"steps": [
{
"id": "task-1",
"title": "Invite your team"
},
{
"id": "task-2",
"title": "Create your first funnel",
"eventName": "funnel_created"
}
],
"conditions": {
"url": "/app",
"urlMatchType": "contains"
}
}
'import requests
url = "https://dash.tinyanalytics.io/api/sites/{site}/guides"
payload = {
"name": "Get started checklist",
"type": "checklist",
"steps": [
{
"id": "task-1",
"title": "Invite your team"
},
{
"id": "task-2",
"title": "Create your first funnel",
"eventName": "funnel_created"
}
],
"conditions": {
"url": "/app",
"urlMatchType": "contains"
}
}
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({
name: 'Get started checklist',
type: 'checklist',
steps: [
{id: 'task-1', title: 'Invite your team'},
{id: 'task-2', title: 'Create your first funnel', eventName: 'funnel_created'}
],
conditions: {url: '/app', urlMatchType: 'contains'}
})
};
fetch('https://dash.tinyanalytics.io/api/sites/{site}/guides', 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://dash.tinyanalytics.io/api/sites/{site}/guides",
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([
'name' => 'Get started checklist',
'type' => 'checklist',
'steps' => [
[
'id' => 'task-1',
'title' => 'Invite your team'
],
[
'id' => 'task-2',
'title' => 'Create your first funnel',
'eventName' => 'funnel_created'
]
],
'conditions' => [
'url' => '/app',
'urlMatchType' => 'contains'
]
]),
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://dash.tinyanalytics.io/api/sites/{site}/guides"
payload := strings.NewReader("{\n \"name\": \"Get started checklist\",\n \"type\": \"checklist\",\n \"steps\": [\n {\n \"id\": \"task-1\",\n \"title\": \"Invite your team\"\n },\n {\n \"id\": \"task-2\",\n \"title\": \"Create your first funnel\",\n \"eventName\": \"funnel_created\"\n }\n ],\n \"conditions\": {\n \"url\": \"/app\",\n \"urlMatchType\": \"contains\"\n }\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://dash.tinyanalytics.io/api/sites/{site}/guides")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Get started checklist\",\n \"type\": \"checklist\",\n \"steps\": [\n {\n \"id\": \"task-1\",\n \"title\": \"Invite your team\"\n },\n {\n \"id\": \"task-2\",\n \"title\": \"Create your first funnel\",\n \"eventName\": \"funnel_created\"\n }\n ],\n \"conditions\": {\n \"url\": \"/app\",\n \"urlMatchType\": \"contains\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.tinyanalytics.io/api/sites/{site}/guides")
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 \"name\": \"Get started checklist\",\n \"type\": \"checklist\",\n \"steps\": [\n {\n \"id\": \"task-1\",\n \"title\": \"Invite your team\"\n },\n {\n \"id\": \"task-2\",\n \"title\": \"Create your first funnel\",\n \"eventName\": \"funnel_created\"\n }\n ],\n \"conditions\": {\n \"url\": \"/app\",\n \"urlMatchType\": \"contains\"\n }\n}"
response = http.request(request)
puts response.read_bodyCreate Guide
Creates a guide as a draft — launch via Update Guide startDate. Steps must match type. Requires manage role.
POST
/
sites
/
{site}
/
guides
Create Guide
curl --request POST \
--url https://dash.tinyanalytics.io/api/sites/{site}/guides \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Get started checklist",
"type": "checklist",
"steps": [
{
"id": "task-1",
"title": "Invite your team"
},
{
"id": "task-2",
"title": "Create your first funnel",
"eventName": "funnel_created"
}
],
"conditions": {
"url": "/app",
"urlMatchType": "contains"
}
}
'import requests
url = "https://dash.tinyanalytics.io/api/sites/{site}/guides"
payload = {
"name": "Get started checklist",
"type": "checklist",
"steps": [
{
"id": "task-1",
"title": "Invite your team"
},
{
"id": "task-2",
"title": "Create your first funnel",
"eventName": "funnel_created"
}
],
"conditions": {
"url": "/app",
"urlMatchType": "contains"
}
}
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({
name: 'Get started checklist',
type: 'checklist',
steps: [
{id: 'task-1', title: 'Invite your team'},
{id: 'task-2', title: 'Create your first funnel', eventName: 'funnel_created'}
],
conditions: {url: '/app', urlMatchType: 'contains'}
})
};
fetch('https://dash.tinyanalytics.io/api/sites/{site}/guides', 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://dash.tinyanalytics.io/api/sites/{site}/guides",
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([
'name' => 'Get started checklist',
'type' => 'checklist',
'steps' => [
[
'id' => 'task-1',
'title' => 'Invite your team'
],
[
'id' => 'task-2',
'title' => 'Create your first funnel',
'eventName' => 'funnel_created'
]
],
'conditions' => [
'url' => '/app',
'urlMatchType' => 'contains'
]
]),
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://dash.tinyanalytics.io/api/sites/{site}/guides"
payload := strings.NewReader("{\n \"name\": \"Get started checklist\",\n \"type\": \"checklist\",\n \"steps\": [\n {\n \"id\": \"task-1\",\n \"title\": \"Invite your team\"\n },\n {\n \"id\": \"task-2\",\n \"title\": \"Create your first funnel\",\n \"eventName\": \"funnel_created\"\n }\n ],\n \"conditions\": {\n \"url\": \"/app\",\n \"urlMatchType\": \"contains\"\n }\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://dash.tinyanalytics.io/api/sites/{site}/guides")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Get started checklist\",\n \"type\": \"checklist\",\n \"steps\": [\n {\n \"id\": \"task-1\",\n \"title\": \"Invite your team\"\n },\n {\n \"id\": \"task-2\",\n \"title\": \"Create your first funnel\",\n \"eventName\": \"funnel_created\"\n }\n ],\n \"conditions\": {\n \"url\": \"/app\",\n \"urlMatchType\": \"contains\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dash.tinyanalytics.io/api/sites/{site}/guides")
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 \"name\": \"Get started checklist\",\n \"type\": \"checklist\",\n \"steps\": [\n {\n \"id\": \"task-1\",\n \"title\": \"Invite your team\"\n },\n {\n \"id\": \"task-2\",\n \"title\": \"Create your first funnel\",\n \"eventName\": \"funnel_created\"\n }\n ],\n \"conditions\": {\n \"url\": \"/app\",\n \"urlMatchType\": \"contains\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
An API key created in your account settings, sent as Authorization: Bearer <key>.
Path Parameters
Site ID.
Body
application/json
Response
Success.
Related topics
Onboarding Checklists and Product ToursAnalytics Roles and PermissionsInstall TinyAnalytics in 5 Minutes⌘I