curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"job_id": "<string>",
"account_id": "<string>",
"metrics": [
"<string>"
],
"format": "markdown"
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch"
payload = {
"job_id": "<string>",
"account_id": "<string>",
"metrics": ["<string>"],
"format": "markdown"
}
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({
job_id: '<string>',
account_id: '<string>',
metrics: ['<string>'],
format: 'markdown'
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch', 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}/x/stats-job-result/fetch",
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([
'job_id' => '<string>',
'account_id' => '<string>',
'metrics' => [
'<string>'
],
'format' => 'markdown'
]),
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}/x/stats-job-result/fetch"
payload := strings.NewReader("{\n \"job_id\": \"<string>\",\n \"account_id\": \"<string>\",\n \"metrics\": [\n \"<string>\"\n ],\n \"format\": \"markdown\"\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}/x/stats-job-result/fetch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"job_id\": \"<string>\",\n \"account_id\": \"<string>\",\n \"metrics\": [\n \"<string>\"\n ],\n \"format\": \"markdown\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch")
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 \"job_id\": \"<string>\",\n \"account_id\": \"<string>\",\n \"metrics\": [\n \"<string>\"\n ],\n \"format\": \"markdown\"\n}"
response = http.request(request)
puts response.read_bodyStats-job-result fetch
Download a finished stats job’s result (gzip JSON on X’s CDN) and render it like adside x stats get: table under the byte budget, summary, derived metrics with formulas. Flags an all-null result explicitly. Costs 2 requests.
CLI: adside x stats-job-result fetch
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"job_id": "<string>",
"account_id": "<string>",
"metrics": [
"<string>"
],
"format": "markdown"
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch"
payload = {
"job_id": "<string>",
"account_id": "<string>",
"metrics": ["<string>"],
"format": "markdown"
}
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({
job_id: '<string>',
account_id: '<string>',
metrics: ['<string>'],
format: 'markdown'
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch', 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}/x/stats-job-result/fetch",
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([
'job_id' => '<string>',
'account_id' => '<string>',
'metrics' => [
'<string>'
],
'format' => 'markdown'
]),
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}/x/stats-job-result/fetch"
payload := strings.NewReader("{\n \"job_id\": \"<string>\",\n \"account_id\": \"<string>\",\n \"metrics\": [\n \"<string>\"\n ],\n \"format\": \"markdown\"\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}/x/stats-job-result/fetch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"job_id\": \"<string>\",\n \"account_id\": \"<string>\",\n \"metrics\": [\n \"<string>\"\n ],\n \"format\": \"markdown\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/x/stats-job-result/fetch")
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 \"job_id\": \"<string>\",\n \"account_id\": \"<string>\",\n \"metrics\": [\n \"<string>\"\n ],\n \"format\": \"markdown\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
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
A job whose status is SUCCESS (adside x stats-job get).
^\d{1,20}$X ads account id (e.g. 18ce55xcrlv). Omit it: it defaults to the ads account this workspace is connected to, and any other account is refused.
Friendly metric names: spend, impressions, engagements, clicks, url_clicks, likes, follows, video_total_views, conversion_purchases, … plus derived ones (cpm, cpe, cplc, ctr, engagement_rate, cpv, cpa, roas) computed here. Default: the ENGAGEMENT + BILLING groups. See adside x metrics list.
markdown, json Response
Success