Onboard a site in one call

Embed

<a href="https://seolyticize.com/docs/ref-onboard-site"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/3e1fe233-c8c9-4749-893b-ce11fd6b6c8a/social-card.svg?v=3e7ae33eec8b" alt="Onboard a site in one call" width="600" height="315"></a>

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

Answers 'set this site up'. Makes the client, project, site and rank tracker — or finds the client already here for this domain, so calling it twice is safe — issues the IndexNow key and a Google site verification for the agency's own Google account, sets up cookieless analytics, and returns one deploy manifest: files to serve at exact paths, tags for the <head>, the analytics snippet placed for the framework given, and CSP entries. Deploy all of it, then call verify_site. No Google sign-in or Search Console settings are needed at any point. Free.

Request body application/json

domainstringrequired

namestring

frameworkstring

keywordsstring[]

verificationstring

file (a page at the site root, the default), meta (a tag in the <head>) or dns (a TXT record, which also covers every subdomain and protocol).

file | meta | dns = file

{
  "domain": "string",
  "name": "string",
  "framework": "nextjs",
  "keywords": [
    "string"
  ],
  "verification": "file"
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/onboard_site" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string","name":"string","framework":"nextjs","keywords":["string"],"verification":"file"}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/onboard_site', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"domain":"string","name":"string","framework":"nextjs","keywords":["string"],"verification":"file"}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/onboard_site",
    headers={
    "Content-Type": "application/json",
    },
    json={"domain": "string", "name": "string", "framework": "nextjs", "keywords": ["string"], "verification": "file"},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/onboard_site", strings.NewReader(`{"domain":"string","name":"string","framework":"nextjs","keywords":["string"],"verification":"file"}`))
	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/onboard_site');
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, '{"domain":"string","name":"string","framework":"nextjs","keywords":["string"],"verification":"file"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/onboard_site')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"domain":"string","name":"string","framework":"nextjs","keywords":["string"],"verification":"file"}'
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/onboard_site"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"domain\":\"string\",\"name\":\"string\",\"framework\":\"nextjs\",\"keywords\":[\"string\"],\"verification\":\"file\"}"))
    .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