List ad sets

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/ad-sets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/ad-sets', 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/ad-sets",
  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/ad-sets"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/ad-sets")

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

{
  "adSets": [
    {
      "adSetName": "<string>",
      "bidAmount": 123,
      "bidStrategy": "<string>",
      "billingEvent": "<string>",
      "budget": {
        "amount": 123,
        "daily": 123,
        "lifetime": 123,
        "pacing": "<string>",
        "type": "daily"
      },
      "configReadAt": "2023-11-07T05:31:56Z",
      "connectionId": "<string>",
      "currency": "<string>",
      "isExternal": true,
      "nativeSettings": {},
      "optimizationGoal": "<string>",
      "platform": "<string>",
      "platformAdAccountId": "<string>",
      "platformAdSetId": "<string>",
      "platformAdSetStatus": "<string>",
      "platformCampaignId": "<string>",
      "platformCreatedAt": "2023-11-07T05:31:56Z",
      "promotedObject": {},
      "schedule": {
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z"
      },
      "status": "<string>",
      "statusReadAt": "2023-11-07T05:31:56Z",
      "targeting": {
        "audienceExpansionEnabled": true,
        "exclude": {},
        "include": {},
        "offsiteDeliveryEnabled": true
      }
    }
  ],
  "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 ad sets

Ad Campaigns. Read only. Lists ad sets (ad groups on Google) with their targeting, bidding and optimization settings, optionally for one campaign. Returns the ad sets (Google ad groups) synced for the connection, optionally filtered by platform and campaignId. It reads the `ad_sets` table directly, independent of the `ads` rollup GET /apis/v1/ads/tree uses.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

GET

https://api.aisa.one

apis

ads

ad-sets

List ad sets

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/ad-sets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/ad-sets', 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/ad-sets",
  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/ad-sets"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/ad-sets")

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

{
  "adSets": [
    {
      "adSetName": "<string>",
      "bidAmount": 123,
      "bidStrategy": "<string>",
      "billingEvent": "<string>",
      "budget": {
        "amount": 123,
        "daily": 123,
        "lifetime": 123,
        "pacing": "<string>",
        "type": "daily"
      },
      "configReadAt": "2023-11-07T05:31:56Z",
      "connectionId": "<string>",
      "currency": "<string>",
      "isExternal": true,
      "nativeSettings": {},
      "optimizationGoal": "<string>",
      "platform": "<string>",
      "platformAdAccountId": "<string>",
      "platformAdSetId": "<string>",
      "platformAdSetStatus": "<string>",
      "platformCampaignId": "<string>",
      "platformCreatedAt": "2023-11-07T05:31:56Z",
      "promotedObject": {},
      "schedule": {
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z"
      },
      "status": "<string>",
      "statusReadAt": "2023-11-07T05:31:56Z",
      "targeting": {
        "audienceExpansionEnabled": true,
        "exclude": {},
        "include": {},
        "offsiteDeliveryEnabled": true
      }
    }
  ],
  "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/ad-sets
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/ad-sets
connectionId: query; required
adAccountId: query; optional
campaignId: query; optional
adSetId: query; optional
platform: query; optional
status: query; optional
page: query; optional
limit: query; optional
live: query; optional
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "get_aisa_ads_apis_v1_ads_ad_sets",
  "method": "GET",
  "path": "/apis/v1/ads/ad-sets",
  "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": "Platform ad account id (Meta act_). Lists every synced ad set of that ad account; no campaignId needed.",
      "in": "query",
      "name": "adAccountId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Platform campaign ID 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": "Platform ad set ID 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": "adSetId",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "platform",
      "required": false,
      "schema": {
        "enum": [
          "facebook",
          "instagram",
          "tiktok",
          "linkedin",
          "pinterest",
          "google",
          "twitter",
          "openai",
          "reddit",
          "meta",
          "x"
        ],
        "type": "string"
      }
    },
    {
      "description": "Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.",
      "in": "query",
      "name": "status",
      "required": false,
      "schema": {
        "enum": [
          "active",
          "paused",
          "pending_review",
          "rejected",
          "completed",
          "cancelled",
          "error"
        ],
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 1,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "default": 500,
        "maximum": 500,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

connectionId

string

required

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]+$

adAccountId

string

Platform ad account id (Meta act_). Lists every synced ad set of that ad account; no campaignId needed.

campaignId

string

Platform campaign ID Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

adSetId

string

Platform ad set ID Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

platform

enum<string>

Available options:

facebook,

instagram,

tiktok,

linkedin,

pinterest,

google,

twitter,

openai,

reddit,

meta,

x

status

enum<string>

Filter by the ad set's stored status, the value each row returns. A live read does not change it. Rows whose status is null match no filter.

Available options:

active,

paused,

pending_review,

rejected,

completed,

cancelled,

error

page

integer

default:1

Required range: x >= 1

limit

integer

default:500

Required range: 1 <= x <= 500

live

boolean

default:false

Read the on/off switches live from the platform instead of returning synced values. See "Status freshness" in the operation description.

Response

Ad sets

adSets

object[]

Show child attributes

pagination

object

Show child attributes

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Response

Request contract

Cost and request rules