Get Trending Evaluation

GET

api

admin

trending

evaluations

:jobId

Get Trending Evaluation

curl --request GET \
  --url https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId', 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://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "jobId": "123",
    "status": "running",
    "twitterUserId": "2096234819822694402",
    "window": "24h",
    "result": null,
    "error": null,
    "correlationId": "example-evaluation"
  }
}

Admin authentication required. Results are retained for up to one day, subject to a 100-job retention limit per terminal state. Unknown, expired, and unrelated job IDs return 404. published describes this evaluation’s saved snapshot; later ranking runs may change the list. Passing numerical minimums alone does not guarantee placement.

Parameters

string

required

Job ID returned by the evaluation trigger.

Response

string

queued, running, completed, or failed.

object | null

Completed result: evidence, published, rank (null when excluded), snapshotSaved, generatedAt, and exclusion reason. Reasons: insufficient_followers, insufficient_recorded_scout_follows, suppressed, outside_top_list_or_filtered_by_enrichment.

string | null

Sanitized worker failure message. No publication success is claimed on failure.

string

Reference for worker logs and external calls.

{
  "success": true,
  "data": {
    "jobId": "123",
    "status": "running",
    "twitterUserId": "2096234819822694402",
    "window": "24h",
    "result": null,
    "error": null,
    "correlationId": "example-evaluation"
  }
}

Get Trending Evaluation

curl --request GET \
  --url https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId', 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://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.openbits.ai/api/v1/admin/trending/evaluations/:jobId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "jobId": "123",
    "status": "running",
    "twitterUserId": "2096234819822694402",
    "window": "24h",
    "result": null,
    "error": null,
    "correlationId": "example-evaluation"
  }
}

Overview

Users

Timelines

Social Graph

Tweets

Communities

Lists

Bulk Export

Admin Diagnostics

Admin

Discovery

Get Trending Evaluation

Parameters

Response