curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source": "META",
"from": "<string>",
"to": "<string>",
"period": "last_7_days",
"limit": 10,
"format": "all",
"sortBy": "spend",
"sortOrder": "desc",
"conversionEvent": "<string>"
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank"
payload = {
"source": "META",
"from": "<string>",
"to": "<string>",
"period": "last_7_days",
"limit": 10,
"format": "all",
"sortBy": "spend",
"sortOrder": "desc",
"conversionEvent": "<string>"
}
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({
source: 'META',
from: '<string>',
to: '<string>',
period: 'last_7_days',
limit: 10,
format: 'all',
sortBy: 'spend',
sortOrder: 'desc',
conversionEvent: '<string>'
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/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.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/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([
'source' => 'META',
'from' => '<string>',
'to' => '<string>',
'period' => 'last_7_days',
'limit' => 10,
'format' => 'all',
'sortBy' => 'spend',
'sortOrder' => 'desc',
'conversionEvent' => '<string>'
]),
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.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank"
payload := strings.NewReader("{\n \"source\": \"META\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"period\": \"last_7_days\",\n \"limit\": 10,\n \"format\": \"all\",\n \"sortBy\": \"spend\",\n \"sortOrder\": \"desc\",\n \"conversionEvent\": \"<string>\"\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.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"META\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"period\": \"last_7_days\",\n \"limit\": 10,\n \"format\": \"all\",\n \"sortBy\": \"spend\",\n \"sortOrder\": \"desc\",\n \"conversionEvent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/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 \"source\": \"META\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"period\": \"last_7_days\",\n \"limit\": 10,\n \"format\": \"all\",\n \"sortBy\": \"spend\",\n \"sortOrder\": \"desc\",\n \"conversionEvent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"text": "<string>"
}Creatives rank
Get top creatives
CLI: adside reporting creatives rank
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source": "META",
"from": "<string>",
"to": "<string>",
"period": "last_7_days",
"limit": 10,
"format": "all",
"sortBy": "spend",
"sortOrder": "desc",
"conversionEvent": "<string>"
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank"
payload = {
"source": "META",
"from": "<string>",
"to": "<string>",
"period": "last_7_days",
"limit": 10,
"format": "all",
"sortBy": "spend",
"sortOrder": "desc",
"conversionEvent": "<string>"
}
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({
source: 'META',
from: '<string>',
to: '<string>',
period: 'last_7_days',
limit: 10,
format: 'all',
sortBy: 'spend',
sortOrder: 'desc',
conversionEvent: '<string>'
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/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.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/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([
'source' => 'META',
'from' => '<string>',
'to' => '<string>',
'period' => 'last_7_days',
'limit' => 10,
'format' => 'all',
'sortBy' => 'spend',
'sortOrder' => 'desc',
'conversionEvent' => '<string>'
]),
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.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank"
payload := strings.NewReader("{\n \"source\": \"META\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"period\": \"last_7_days\",\n \"limit\": 10,\n \"format\": \"all\",\n \"sortBy\": \"spend\",\n \"sortOrder\": \"desc\",\n \"conversionEvent\": \"<string>\"\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.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/rank")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"META\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"period\": \"last_7_days\",\n \"limit\": 10,\n \"format\": \"all\",\n \"sortBy\": \"spend\",\n \"sortOrder\": \"desc\",\n \"conversionEvent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/reporting/creatives/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 \"source\": \"META\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"period\": \"last_7_days\",\n \"limit\": 10,\n \"format\": \"all\",\n \"sortBy\": \"spend\",\n \"sortOrder\": \"desc\",\n \"conversionEvent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"text": "<string>"
}Authorizations
A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.
Path Parameters
1Body
Ad platform to read: META, TIKTOK, GOOGLE (YouTube video ads), LINKEDIN, SNAPCHAT or REDDIT. Defaults to META.
META, TIKTOK, GOOGLE, LINKEDIN, SNAPCHAT, REDDIT Inclusive start date, yyyy-MM-dd. Use together with to; takes precedence over period.
^\d{4}-\d{2}-\d{2}$Inclusive end date, yyyy-MM-dd.
^\d{4}-\d{2}-\d{2}$Preset window used when from/to are omitted.
today, yesterday, last_7_days, last_4_weeks, last_3_months, last_12_months, week_to_date, month_to_date, quarter_to_date, year_to_date, all_time, last_30_days How many creatives to return (1-20). Defaults to 10.
1 <= x <= 20Keep only video or static creatives. Defaults to all.
all, video, static Ranking column. conversion ranks by the conversion event (see conversionEvent / sortSubMetric). A column the platform cannot sort by falls back to spend.
spend, impressions, reach, clicks, frequency, ctr, cpm, cpc, thumbstop, conversion, comments desc = highest first (use asc with cost metrics for cheapest).
asc, desc With sortBy conversion: which conversion figure to rank by — count, costPer, rate, value or roas. Defaults to count.
costPer, count, rate, value, roas Platform conversion event to report (e.g. a Meta action_type). Defaults to the workspace's primary mapped conversion for the platform.
1 - 256Response
Success