Submit async insights report

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/insights/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "objectId": "1234567890"
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/insights/reports"

payload = { "objectId": "1234567890" }
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({objectId: '1234567890'})
};

fetch('https://api.aisa.one/apis/v1/ads/insights/reports', 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/insights/reports",
  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([
    'objectId' => '1234567890'
  ]),
  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.aisa.one/apis/v1/ads/insights/reports"

	payload := strings.NewReader("{\n  \"objectId\": \"1234567890\"\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.aisa.one/apis/v1/ads/insights/reports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"objectId\": \"1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/insights/reports")

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  \"objectId\": \"1234567890\"\n}"

response = http.request(request)
puts response.read_body

{
  "reportRunId": "<string>",
  "status": "<string>"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

AIsa Ads

Submit async insights report

Ad Insights. Read only. Starts a background Meta insights report for long date ranges or large accounts where a live query would be too slow. Same query surface as GET /apis/v1/ads/insights, but in the JSON body; Meta processes the report server-side, which is the right choice for long ranges or large accounts where the sync query is slow or rate-limited.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

POST

https://api.aisa.one

apis

ads

insights

reports

Submit async insights report

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/insights/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "objectId": "1234567890"
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/insights/reports"

payload = { "objectId": "1234567890" }
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({objectId: '1234567890'})
};

fetch('https://api.aisa.one/apis/v1/ads/insights/reports', 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/insights/reports",
  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([
    'objectId' => '1234567890'
  ]),
  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.aisa.one/apis/v1/ads/insights/reports"

	payload := strings.NewReader("{\n  \"objectId\": \"1234567890\"\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.aisa.one/apis/v1/ads/insights/reports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"objectId\": \"1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/insights/reports")

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  \"objectId\": \"1234567890\"\n}"

response = http.request(request)
puts response.read_body

{
  "reportRunId": "<string>",
  "status": "<string>"
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

Request contract

Method and path: POST /apis/v1/ads/insights/reports
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/insights/reports
connectionId: query; required
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

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

{
  "operationId": "post_aisa_ads_apis_v1_ads_insights_reports",
  "method": "POST",
  "path": "/apis/v1/ads/insights/reports",
  "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"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "example": {
          "connectionId": "adc_7f3k2m9q",
          "objectId": "1234567890"
        },
        "schema": {
          "additionalProperties": true,
          "properties": {
            "actionAttributionWindows": {
              "description": "Meta attribution windows (e.g. [\"7d_click\", \"1d_view\"]). Action values are returned keyed per window.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "actionBreakdowns": {
              "description": "Comma-separated Graph action breakdowns (e.g. action_type,action_destination). Pass `none` to clear Meta's default action_type breakdown, needed for some non-action breakdowns such as instagram_ads_follow_type.",
              "type": "string"
            },
            "actionReportTime": {
              "description": "When actions are counted: impression, conversion or mixed.",
              "type": "string"
            },
            "breakdowns": {
              "description": "Comma-separated Graph breakdowns.",
              "type": "string"
            },
            "connectionId": {
              "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
              "pattern": "^adc_[0-9A-Za-z]+$",
              "type": "string"
            },
            "datePreset": {
              "description": "Mutually exclusive with fromDate/toDate.",
              "type": "string"
            },
            "fields": {
              "description": "Comma-separated Graph insights fields.",
              "type": "string"
            },
            "filtering": {
              "description": "Meta filter objects, applied server-side.",
              "items": {
                "properties": {
                  "field": {
                    "type": "string"
                  },
                  "operator": {
                    "type": "string"
                  },
                  "value": {}
                },
                "required": [
                  "field",
                  "operator"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "fromDate": {
              "format": "date",
              "type": "string"
            },
            "level": {
              "enum": [
                "ad",
                "adset",
                "campaign",
                "account"
              ],
              "type": "string"
            },
            "objectId": {
              "description": "Meta insights node: act_, campaign id, ad set id or ad 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.",
              "type": "string"
            },
            "timeIncrement": {
              "oneOf": [
                {
                  "maximum": 90,
                  "minimum": 1,
                  "type": "integer"
                },
                {
                  "enum": [
                    "monthly",
                    "all_days"
                  ],
                  "type": "string"
                }
              ]
            },
            "toDate": {
              "format": "date",
              "type": "string"
            },
            "useUnifiedAttributionSetting": {
              "description": "Use the ad sets' own attribution settings for action counting.",
              "type": "boolean"
            }
          },
          "required": [
            "objectId"
          ],
          "type": "object"
        }
      }
    },
    "required": true
  },
  "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]+$

Body

application/json

objectId

string

required

Meta insights node: act_, campaign id, ad set id or ad 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.

actionAttributionWindows

string[]

Meta attribution windows (e.g. ["7d_click", "1d_view"]). Action values are returned keyed per window.

actionBreakdowns

string

Comma-separated Graph action breakdowns (e.g. action_type,action_destination). Pass none to clear Meta's default action_type breakdown, needed for some non-action breakdowns such as instagram_ads_follow_type.

actionReportTime

string

When actions are counted: impression, conversion or mixed.

breakdowns

string

Comma-separated Graph breakdowns.

connectionId

string

The ads connection (adc_...), when not sent as the connectionId query parameter.

Pattern: ^adc_[0-9A-Za-z]+$

datePreset

string

Mutually exclusive with fromDate/toDate.

fields

string

Comma-separated Graph insights fields.

filtering

object[]

Meta filter objects, applied server-side.

Show child attributes

fromDate

string<date>

level

enum<string>

Available options:

ad,

adset,

campaign,

account

timeIncrement

Required range: 1 <= x <= 90

toDate

string<date>

useUnifiedAttributionSetting

boolean

Use the ad sets' own attribution settings for action counting.

Response

Report run submitted

reportRunId

string

status

string

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Body

Response

Request contract

Cost and request rules