Get a link for a person to connect a service

Embed

<a href="https://seolyticize.com/docs/ref-get-connection-link"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/0cafb220-ced6-4f6f-9c53-6a3454710702/social-card.svg?v=3e7ae33eec8b" alt="Get a link for a person to connect a service" width="600" height="315"></a>

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

The link a PERSON must open to connect one of a client's accounts — Google Search Console (search_console), Search Console sitemap management (search_console_sitemaps), Google Analytics 4 (google_analytics), Yandex Webmaster (yandex_webmaster) or a Google Business Profile listing (google_business_profile) — with what they will be asked to approve and what is connected now. Answers 'connect Search Console for this client' and 'did the connection work'. An agent cannot complete these itself: the account owner signs in to that service and grants access. Give the url and the steps to your human, then call this again to check state. The person must be signed in to Seolyticize with permission to manage the client. google_analytics needs ga4PropertyId (the numeric property id, not a G- measurement id); google_business_profile needs locationId; search_console takes an optional propertyUrl (default: the client's site, https://domain/; a Domain property is sc-domain:example.com). Free.

Request body application/json

clientIdstringrequired

servicestringrequired

search_console | search_console_sitemaps | google_analytics | yandex_webmaster | google_business_profile

propertyUrlstring

ga4PropertyIdstring

locationIdstring

{
  "clientId": "string",
  "service": "search_console",
  "propertyUrl": "string",
  "ga4PropertyId": "string",
  "locationId": "string"
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/get_connection_link" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","service":"search_console","propertyUrl":"string","ga4PropertyId":"string","locationId":"string"}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/get_connection_link', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","service":"search_console","propertyUrl":"string","ga4PropertyId":"string","locationId":"string"}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/get_connection_link",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "service": "search_console", "propertyUrl": "string", "ga4PropertyId": "string", "locationId": "string"},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/get_connection_link", strings.NewReader(`{"clientId":"string","service":"search_console","propertyUrl":"string","ga4PropertyId":"string","locationId":"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/get_connection_link');
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, '{"clientId":"string","service":"search_console","propertyUrl":"string","ga4PropertyId":"string","locationId":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/get_connection_link')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","service":"search_console","propertyUrl":"string","ga4PropertyId":"string","locationId":"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/get_connection_link"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"service\":\"search_console\",\"propertyUrl\":\"string\",\"ga4PropertyId\":\"string\",\"locationId\":\"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