Get the status of a run

Embed

<a href="https://seolyticize.com/docs/ref-get-run-status"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/e5e21126-3aff-483b-8f9f-d91ac3cbcaba/social-card.svg?v=3e7ae33eec8b" alt="Get the status of a run" width="600" height="315"></a>

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

How a run started with refresh_rankings or refresh_domain_data is going: running, done or failed, and — when it failed or captured only some keywords — the reason, written for an agency to act on (a missing vendor key, an unreachable site). Answers 'did that capture work'. A run id that is not this client's, or that has aged out, reads as unknown.

Request body application/json

clientIdstringrequired

jobstringrequired

rank | domain

runIdstringrequired

{
  "clientId": "string",
  "job": "rank",
  "runId": "string"
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/get_run_status" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","job":"rank","runId":"string"}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/get_run_status', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","job":"rank","runId":"string"}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/get_run_status",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "job": "rank", "runId": "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_run_status", strings.NewReader(`{"clientId":"string","job":"rank","runId":"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_run_status');
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","job":"rank","runId":"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_run_status')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","job":"rank","runId":"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_run_status"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"job\":\"rank\",\"runId\":\"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