Get ads hierarchy
curl --request GET \
--url https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}', 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.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"effectiveStatus": "<string>",
"objective": "<string>",
"dailyBudget": "<string>",
"lifetimeBudget": "<string>",
"adSets": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"effectiveStatus": "<string>",
"destinationType": "<string>",
"dailyBudget": "<string>",
"lifetimeBudget": "<string>",
"optimizationGoal": "<string>",
"billingEvent": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"ads": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"effectiveStatus": "<string>",
"creative": {
"id": "<string>",
"imageUrl": "<string>",
"thumbnailUrl": "<string>",
"message": "<string>",
"linkUrl": "<string>",
"videoId": "<string>",
"headline": "<string>",
"description": "<string>",
"callToActionType": "<string>",
"leadForm": {
"id": "<string>",
"name": "<string>"
},
"messageOptions": [
"<string>"
],
"headlineOptions": [
"<string>"
],
"descriptionOptions": [
"<string>"
]
},
"insights": {
"impressions": "<string>",
"reach": "<string>",
"clicks": "<string>",
"spend": "<string>",
"ctr": "<string>",
"cpc": "<string>",
"cpm": "<string>",
"frequency": "<string>"
}
}
],
"insights": {
"impressions": "<string>",
"reach": "<string>",
"clicks": "<string>",
"spend": "<string>",
"ctr": "<string>",
"cpc": "<string>",
"cpm": "<string>",
"frequency": "<string>"
},
"targeting": {
"geoLocations": {
"countries": [
"<string>"
],
"cities": [
{
"key": "<string>",
"radius": 123,
"distance_unit": "<string>"
}
],
"regions": [
{
"key": "<string>"
}
]
},
"ageMin": 123,
"ageMax": 123,
"genders": [
123
],
"interests": [
{
"id": "<string>",
"name": "<string>"
}
],
"behaviors": [
{
"id": "<string>",
"name": "<string>"
}
],
"customAudiences": [
{
"id": "<string>"
}
],
"excludedCustomAudiences": [
{
"id": "<string>"
}
]
}
}
],
"insights": {
"impressions": "<string>",
"reach": "<string>",
"clicks": "<string>",
"spend": "<string>",
"ctr": "<string>",
"cpc": "<string>",
"cpm": "<string>",
"frequency": "<string>"
}
}
]
}
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}Ads
Get ads hierarchy
Get complete campaign/ad set/ad hierarchy in one optimized request. Use datePreset=maximum to pull lifetime insights for paused/historical campaigns (the last_30d default returns null insights for entities with no recent spend).
GET
/
socials
/
ads
/
hierarchy
/
{projectId}
/
{accountId}
/
{adAccountId}
Get ads hierarchy
curl --request GET \
--url https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}', 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.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sapt.ai/socials/ads/hierarchy/{projectId}/{accountId}/{adAccountId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"effectiveStatus": "<string>",
"objective": "<string>",
"dailyBudget": "<string>",
"lifetimeBudget": "<string>",
"adSets": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"effectiveStatus": "<string>",
"destinationType": "<string>",
"dailyBudget": "<string>",
"lifetimeBudget": "<string>",
"optimizationGoal": "<string>",
"billingEvent": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"ads": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"effectiveStatus": "<string>",
"creative": {
"id": "<string>",
"imageUrl": "<string>",
"thumbnailUrl": "<string>",
"message": "<string>",
"linkUrl": "<string>",
"videoId": "<string>",
"headline": "<string>",
"description": "<string>",
"callToActionType": "<string>",
"leadForm": {
"id": "<string>",
"name": "<string>"
},
"messageOptions": [
"<string>"
],
"headlineOptions": [
"<string>"
],
"descriptionOptions": [
"<string>"
]
},
"insights": {
"impressions": "<string>",
"reach": "<string>",
"clicks": "<string>",
"spend": "<string>",
"ctr": "<string>",
"cpc": "<string>",
"cpm": "<string>",
"frequency": "<string>"
}
}
],
"insights": {
"impressions": "<string>",
"reach": "<string>",
"clicks": "<string>",
"spend": "<string>",
"ctr": "<string>",
"cpc": "<string>",
"cpm": "<string>",
"frequency": "<string>"
},
"targeting": {
"geoLocations": {
"countries": [
"<string>"
],
"cities": [
{
"key": "<string>",
"radius": 123,
"distance_unit": "<string>"
}
],
"regions": [
{
"key": "<string>"
}
]
},
"ageMin": 123,
"ageMax": 123,
"genders": [
123
],
"interests": [
{
"id": "<string>",
"name": "<string>"
}
],
"behaviors": [
{
"id": "<string>",
"name": "<string>"
}
],
"customAudiences": [
{
"id": "<string>"
}
],
"excludedCustomAudiences": [
{
"id": "<string>"
}
]
}
}
],
"insights": {
"impressions": "<string>",
"reach": "<string>",
"clicks": "<string>",
"spend": "<string>",
"ctr": "<string>",
"cpc": "<string>",
"cpm": "<string>",
"frequency": "<string>"
}
}
]
}
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}{
"message": "<string>",
"code": "<string>"
}Authorizations
JWT token obtained from /api/auth/token endpoint. Token is verified using JWKS and must include a valid user identifier.
Path Parameters
Query Parameters
Available options:
today, yesterday, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, this_month, last_month, this_quarter, last_quarter, this_year, last_year, maximum