Save a report template

Embed

<a href="https://seolyticize.com/docs/ref-save-report-template"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/e30ad21a-c004-4873-971b-77d28b7b10a9/social-card.svg?v=3e7ae33eec8b" alt="Save a report template" width="600" height="315"></a>

POSThttps://seolyticize.com/api/v1/tools/save_report_template

Saves a reusable brief for a kind of report: a name, who it is for, sections in order (each with a line on what goes under it), tone and sign-off. Answers 'make this our monthly report format'. Without clientId it is agency-wide, which only someone who sees every client may change; with one it is that client's own. Without templateId a new template is made; with one, it is replaced. Only save a template when the user asks for one — a one-off report needs none. Free.

Request body application/json

templateIdstring

clientIdstring

= null

namestringrequired

descriptionstring

audiencestring

sectionsobject[]required

Show child parameters

headingstringrequired

guidancestring

tonestring

signOffstring

{
  "templateId": "string",
  "clientId": null,
  "name": "string",
  "description": "string",
  "audience": "string",
  "sections": [
    {
      "heading": "string",
      "guidance": "string"
    }
  ],
  "tone": "string",
  "signOff": "string"
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/save_report_template" \
  -H "Content-Type: application/json" \
  -d '{"templateId":"string","clientId":null,"name":"string","description":"string","audience":"string","sections":[{"heading":"string","guidance":"string"}],"tone":"string","signOff":"string"}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/save_report_template', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"templateId":"string","clientId":null,"name":"string","description":"string","audience":"string","sections":[{"heading":"string","guidance":"string"}],"tone":"string","signOff":"string"}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/save_report_template",
    headers={
    "Content-Type": "application/json",
    },
    json={"templateId": "string", "clientId": None, "name": "string", "description": "string", "audience": "string", "sections": [{"heading": "string", "guidance": "string"}], "tone": "string", "signOff": "string"},
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/save_report_template", strings.NewReader(`{"templateId":"string","clientId":null,"name":"string","description":"string","audience":"string","sections":[{"heading":"string","guidance":"string"}],"tone":"string","signOff":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://seolyticize.com/api/v1/tools/save_report_template');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"templateId":"string","clientId":null,"name":"string","description":"string","audience":"string","sections":[{"heading":"string","guidance":"string"}],"tone":"string","signOff":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/save_report_template')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"templateId":"string","clientId":null,"name":"string","description":"string","audience":"string","sections":[{"heading":"string","guidance":"string"}],"tone":"string","signOff":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://seolyticize.com/api/v1/tools/save_report_template"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"templateId\":\"string\",\"clientId\":null,\"name\":\"string\",\"description\":\"string\",\"audience\":\"string\",\"sections\":[{\"heading\":\"string\",\"guidance\":\"string\"}],\"tone\":\"string\",\"signOff\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 The tool's result, under data.

Example

{
  "data": {}
}

Schema

datarequired

400 The body was not JSON or did not match the tool's input schema.

Example

{
  "error": "string"
}

Schema

errorstringrequired