Rank Ad Library Feed Semantically
curl --request POST \
--url https://api.example.com/api/v1/ad-library/semantic-rank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"ad_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"limit": 100
}
'import requests
url = "https://api.example.com/api/v1/ad-library/semantic-rank"
payload = {
"query": "<string>",
"ad_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"limit": 100
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
ad_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
limit: 100
})
};
fetch('https://api.example.com/api/v1/ad-library/semantic-rank', 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.example.com/api/v1/ad-library/semantic-rank",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'ad_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ad-library/semantic-rank"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/ad-library/semantic-rank")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ad-library/semantic-rank")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"ad_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"returned": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Ad Library
Rank Ad Library Feed Semantically
Meaning-rank only the ads in a fixed client feed.
Top Ads, Analyzed Ads, and Swipe File are finite collections assembled by the dashboard. Their semantic search must never substitute unrelated global library cards, so the caller supplies the exact allowed ad ids.
POST
/
api
/
v1
/
ad-library
/
semantic-rank
Rank Ad Library Feed Semantically
curl --request POST \
--url https://api.example.com/api/v1/ad-library/semantic-rank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"ad_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"limit": 100
}
'import requests
url = "https://api.example.com/api/v1/ad-library/semantic-rank"
payload = {
"query": "<string>",
"ad_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"limit": 100
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
ad_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
limit: 100
})
};
fetch('https://api.example.com/api/v1/ad-library/semantic-rank', 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.example.com/api/v1/ad-library/semantic-rank",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'ad_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'limit' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/ad-library/semantic-rank"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/ad-library/semantic-rank")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/ad-library/semantic-rank")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"ad_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_body{
"query": "<string>",
"ad_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"returned": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Was this page helpful?
⌘I