List campaigns
curl --request GET \
--url https://api.aisa.one/apis/v1/ads/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/ads/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/ads/campaigns', 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.aisa.one/apis/v1/ads/campaigns",
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.aisa.one/apis/v1/ads/campaigns"
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.aisa.one/apis/v1/ads/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/campaigns")
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{
"campaigns": [
{
"adCount": 123,
"advertisingChannelType": "<string>",
"bidAmount": 123,
"bidStrategy": "LOWEST_COST_WITHOUT_CAP",
"budget": {
"amount": 123,
"type": "daily",
"amountMicros": "<string>",
"deliveryMethod": "<string>",
"explicitlyShared": true,
"resourceName": "<string>"
},
"budgetLevel": "campaign",
"campaignBudget": {
"amount": 123,
"type": "daily",
"amountMicros": "<string>",
"deliveryMethod": "<string>",
"explicitlyShared": true,
"resourceName": "<string>"
},
"campaignIssuesInfo": [
{}
],
"campaignName": "<string>",
"configReadAt": "2023-11-07T05:31:56Z",
"connectionId": "<string>",
"currency": "<string>",
"earliestAd": "2023-11-07T05:31:56Z",
"isBudgetScheduleEnabled": false,
"isSmartPlus": true,
"latestAd": "2023-11-07T05:31:56Z",
"metrics": {
"actionValues": {},
"actions": {},
"allConversions": 123,
"clicks": 123,
"conversions": 123,
"costPerAction": {},
"costPerConversion": 123,
"costPerThruplay": 123,
"cpc": 123,
"cpm": 123,
"ctr": 123,
"engagement": 123,
"engagementBreakdown": {},
"funnel": {},
"impressions": 123,
"inlineLinkClickCtr": 123,
"inlineLinkClicks": 123,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"outboundClicks": 123,
"outboundClicksCtr": 123,
"purchaseValue": 123,
"reach": 123,
"roas": 123,
"spend": 123,
"uniqueClicks": 123,
"uniqueCtr": 123,
"video2SecWatchedActions": 123,
"video30SecWatchedActions": 123,
"video6SecFocusedViews": 123,
"video6SecWatchedActions": 123,
"videoAvgTimeWatchedActions": 123,
"videoP100WatchedActions": 123,
"videoP25WatchedActions": 123,
"videoP50WatchedActions": 123,
"videoP75WatchedActions": 123,
"videoP95WatchedActions": 123,
"videoPlayActions": 123,
"videoThruplayWatchedActions": 123
},
"nativeSettings": {},
"optimizationGoal": "<string>",
"platform": "facebook",
"platformAdAccountId": "<string>",
"platformAdAccountName": "<string>",
"platformCampaignId": "<string>",
"platformCampaignStatus": "<string>",
"platformObjective": "<string>",
"promotedObject": {
"custom_event_type": "<string>",
"page_id": "<string>",
"pixel_id": "<string>"
},
"reviewStatus": "in_review",
"roasAverageFloor": 123,
"status": "active",
"statusReadAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"page": 123,
"pages": 123,
"total": 123
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
List campaigns
Ad Campaigns. Read only. Lists your campaigns with spend, impressions and clicks summed across their ads, plus each campaign's status and budget. Campaigns are virtual aggregations over ad documents grouped by platform campaign ID. Metrics (spend, impressions, clicks, etc.) are summed across all ads in each campaign.
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
GET
https://api.aisa.one
/
apis
/
v1
/
ads
/
campaigns
List campaigns
curl --request GET \
--url https://api.aisa.one/apis/v1/ads/campaigns \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/ads/campaigns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/ads/campaigns', 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.aisa.one/apis/v1/ads/campaigns",
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.aisa.one/apis/v1/ads/campaigns"
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.aisa.one/apis/v1/ads/campaigns")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/campaigns")
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{
"campaigns": [
{
"adCount": 123,
"advertisingChannelType": "<string>",
"bidAmount": 123,
"bidStrategy": "LOWEST_COST_WITHOUT_CAP",
"budget": {
"amount": 123,
"type": "daily",
"amountMicros": "<string>",
"deliveryMethod": "<string>",
"explicitlyShared": true,
"resourceName": "<string>"
},
"budgetLevel": "campaign",
"campaignBudget": {
"amount": 123,
"type": "daily",
"amountMicros": "<string>",
"deliveryMethod": "<string>",
"explicitlyShared": true,
"resourceName": "<string>"
},
"campaignIssuesInfo": [
{}
],
"campaignName": "<string>",
"configReadAt": "2023-11-07T05:31:56Z",
"connectionId": "<string>",
"currency": "<string>",
"earliestAd": "2023-11-07T05:31:56Z",
"isBudgetScheduleEnabled": false,
"isSmartPlus": true,
"latestAd": "2023-11-07T05:31:56Z",
"metrics": {
"actionValues": {},
"actions": {},
"allConversions": 123,
"clicks": 123,
"conversions": 123,
"costPerAction": {},
"costPerConversion": 123,
"costPerThruplay": 123,
"cpc": 123,
"cpm": 123,
"ctr": 123,
"engagement": 123,
"engagementBreakdown": {},
"funnel": {},
"impressions": 123,
"inlineLinkClickCtr": 123,
"inlineLinkClicks": 123,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"outboundClicks": 123,
"outboundClicksCtr": 123,
"purchaseValue": 123,
"reach": 123,
"roas": 123,
"spend": 123,
"uniqueClicks": 123,
"uniqueCtr": 123,
"video2SecWatchedActions": 123,
"video30SecWatchedActions": 123,
"video6SecFocusedViews": 123,
"video6SecWatchedActions": 123,
"videoAvgTimeWatchedActions": 123,
"videoP100WatchedActions": 123,
"videoP25WatchedActions": 123,
"videoP50WatchedActions": 123,
"videoP75WatchedActions": 123,
"videoP95WatchedActions": 123,
"videoPlayActions": 123,
"videoThruplayWatchedActions": 123
},
"nativeSettings": {},
"optimizationGoal": "<string>",
"platform": "facebook",
"platformAdAccountId": "<string>",
"platformAdAccountName": "<string>",
"platformCampaignId": "<string>",
"platformCampaignStatus": "<string>",
"platformObjective": "<string>",
"promotedObject": {
"custom_event_type": "<string>",
"page_id": "<string>",
"pixel_id": "<string>"
},
"reviewStatus": "in_review",
"roasAverageFloor": 123,
"status": "active",
"statusReadAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"page": 123,
"pages": 123,
"total": 123
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: GET /apis/v1/ads/campaigns
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/campaigns - connectionId: query; required
- includeEmpty: query; optional
- page: query; optional
- limit: query; optional
- source: query; optional
- platform: query; optional
- status: query; optional
- adAccountId: query; optional
- campaignId: query; optional
- pageId: query; optional
- fromDate: query; optional
- toDate: query; optional
- hasDelivery: query; optional
- minSpend: query; optional
- live: query; optional
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "get_aisa_ads_apis_v1_ads_campaigns",
"method": "GET",
"path": "/apis/v1/ads/campaigns",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
"in": "query",
"name": "connectionId",
"required": true,
"schema": {
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
}
},
{
"description": "Meta only. Set true to also list campaigns with ZERO ads, with `adCount: 0` and zeroed metrics. Campaign reads aggregate over ad documents, so such campaigns are normally invisible.",
"in": "query",
"name": "includeEmpty",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Page number (1-based)",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"minimum": 1,
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "Matches the web UI's default view. Status is NOT filtered by default; use the `status` param for that.",
"in": "query",
"name": "source",
"required": false,
"schema": {
"default": "all",
"enum": [
"aisa",
"all"
],
"type": "string"
}
},
{
"in": "query",
"name": "platform",
"required": false,
"schema": {
"enum": [
"facebook",
"instagram",
"tiktok",
"linkedin",
"pinterest",
"google",
"twitter",
"openai",
"reddit",
"microsoft",
"meta",
"x"
],
"type": "string"
}
},
{
"description": "Filter by derived campaign status (post-aggregation)",
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"active",
"paused",
"pending_review",
"rejected",
"completed",
"cancelled",
"error"
],
"type": "string"
}
},
{
"description": "Platform ad account ID (e.g. act_123 for Meta)",
"in": "query",
"name": "adAccountId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Platform campaign ID (the `platformCampaignId` on each returned campaign). Returns only that campaign, or an empty list when it is not visible to the caller. Mirrors the same filter on /apis/v1/ads and /apis/v1/ads/tree. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
"in": "query",
"name": "campaignId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only.",
"in": "query",
"name": "pageId",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.",
"in": "query",
"name": "fromDate",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"description": "End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.",
"in": "query",
"name": "toDate",
"required": false,
"schema": {
"format": "date",
"type": "string"
}
},
{
"description": "Return only campaigns that delivered between `fromDate` and `toDate`: spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window.",
"in": "query",
"name": "hasDelivery",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"description": "Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter.",
"in": "query",
"name": "minSpend",
"required": false,
"schema": {
"minimum": 0,
"type": "number"
}
},
{
"description": "Read the on/off switches live from the platform instead of returning synced values. See \"Status freshness\" in the operation description.",
"in": "query",
"name": "live",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
"kind": "no_customer_charge"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.
Pattern:
^adc_[0-9A-Za-z]+$Meta only. Set true to also list campaigns with ZERO ads, with adCount: 0 and zeroed metrics. Campaign reads aggregate over ad documents, so such campaigns are normally invisible.
Page number (1-based)
Required range:
x >= 1Required range:
1 <= x <= 100Matches the web UI's default view. Status is NOT filtered by default; use the status param for that.
Available options:
aisa, all Available options:
facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai, reddit, microsoft, meta, x Filter by derived campaign status (post-aggregation)
Available options:
active, paused, pending_review, rejected, completed, cancelled, error Platform ad account ID (e.g. act_123 for Meta)
Platform campaign ID (the platformCampaignId on each returned campaign). Returns only that campaign, or an empty list when it is not visible to the caller. Mirrors the same filter on /apis/v1/ads and /apis/v1/ads/tree. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.
Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only.
Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
Return only campaigns that delivered between fromDate and toDate: spend above zero, or impressions served at zero spend. Unlike status, which reads a campaign's CURRENT state, this filters on what happened inside the window.
Return only campaigns whose spend between fromDate and toDate reaches this amount, in each campaign's OWN currency (the currency field on the campaign). Implies hasDelivery; minSpend=0 applies no filter.
Required range:
x >= 0Read the on/off switches live from the platform instead of returning synced values. See "Status freshness" in the operation description.