> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative. > - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key. > - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste. > - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`. > - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt # Flexible live insights query > Ad Insights. Read only. Runs a custom performance query against Meta, Google Ads or TikTok and returns the platform's rows as is, for reports the fixed endpoints don't cover. The account's platform picks the contract. ### Meta (facebook/instagram) Forwards caller-chosen `fields`, `breakdowns` and `filtering` to any Meta insights node and returns Meta's rows verbatim. `objectId` (required) selects the node. 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 ## 请求规范 * **方法与路径:** GET /apis/v1/ads/insights * **可用状态:** enabled * **请求 URL 模板:** `https://api.aisa.one/apis/v1/ads/insights` * **connectionId:** query; 必填 * **objectId:** query; 可选 * **query:** query; 可选 * **adAccountId:** query; 可选 * **reportType:** query; 可选 * **dataLevel:** query; 可选 * **dimensions:** query; 可选 * **metrics:** query; 可选 * **page:** query; 可选 * **pageSize:** query; 可选 * **customerId:** query; 可选 * **pageToken:** query; 可选 * **level:** query; 可选 * **fields:** query; 可选 * **breakdowns:** query; 可选 * **actionBreakdowns:** query; 可选 * **actionAttributionWindows:** query; 可选 * **actionReportTime:** query; 可选 * **useUnifiedAttributionSetting:** query; 可选 * **filtering:** query; 可选 * **datePreset:** query; 可选 * **fromDate:** query; 可选 * **toDate:** query; 可选 * **timeIncrement:** query; 可选 * **limit:** query; 可选 * **after:** query; 可选 * **Runtime 事实版本:** fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 [完整 OpenAPI 定义](https://aisa.one/docs/reference-contracts/zh/aisa-ads.json) 有效请求与价格声明（包括认证和引用的 schema）： ```json theme={null} { "operationId": "get_aisa_ads_apis_v1_ads_insights", "method": "GET", "path": "/apis/v1/ads/insights", "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 (required there): 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.", "in": "query", "name": "objectId", "required": false, "schema": { "type": "string" } }, { "description": "Google only (required there): the GAQL SELECT statement to run.", "in": "query", "name": "query", "required": false, "schema": { "maxLength": 10000, "type": "string" } }, { "description": "Google: platform ad account ID (Google customer ID, digits only) when the connection has several Google Ads accounts. TikTok (required there): the advertiser id.", "in": "query", "name": "adAccountId", "required": false, "schema": { "type": "string" } }, { "description": "TikTok only: report_type.", "in": "query", "name": "reportType", "required": false, "schema": { "default": "BASIC", "enum": [ "BASIC", "AUDIENCE" ], "type": "string" } }, { "description": "TikTok only (required there): data_level.", "in": "query", "name": "dataLevel", "required": false, "schema": { "enum": [ "AUCTION_ADVERTISER", "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" ], "type": "string" } }, { "description": "TikTok only (required there): 1-4 comma-separated TikTok dimensions (e.g. country_code, campaign_id, stat_time_day).", "in": "query", "name": "dimensions", "required": false, "schema": { "type": "string" } }, { "description": "TikTok only (required there): comma-separated TikTok metrics (e.g. reach,impressions,frequency,spend).", "in": "query", "name": "metrics", "required": false, "schema": { "type": "string" } }, { "description": "TikTok only: page number.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "TikTok only: rows per page.", "in": "query", "name": "pageSize", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "Alias of adAccountId, kept for existing callers", "in": "query", "name": "customerId", "required": false, "schema": { "type": "string" } }, { "description": "Google only: cursor from paging.nextPageToken of the previous page.", "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } }, { "description": "Row granularity", "in": "query", "name": "level", "required": false, "schema": { "enum": [ "ad", "adset", "campaign", "account" ], "type": "string" } }, { "description": "Comma-separated Graph insights fields (e.g. spend,impressions,frequency,website_purchase_roas). Omitted = Meta's default set.", "in": "query", "name": "fields", "required": false, "schema": { "type": "string" } }, { "description": "Meta only: comma-separated Graph breakdowns (e.g. age,gender or publisher_platform). Returns 400 on TikTok (add the breakdown to dimensions with reportType=AUDIENCE, e.g.", "in": "query", "name": "breakdowns", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated Graph action breakdowns; segments the actions[] arrays in each row.", "in": "query", "name": "actionBreakdowns", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated Meta attribution windows. Action values are returned keyed per window.", "in": "query", "name": "actionAttributionWindows", "required": false, "schema": { "type": "string" } }, { "description": "When actions are counted: impression, conversion or mixed.", "in": "query", "name": "actionReportTime", "required": false, "schema": { "type": "string" } }, { "description": "Use the ad sets' own attribution settings for action counting.", "in": "query", "name": "useUnifiedAttributionSetting", "required": false, "schema": { "type": "boolean" } }, { "description": "JSON array of filter objects: [{\"field\", \"operator\", \"value\"}]. Applied server-side by Meta or TikTok (TikTok fields e.g. campaign_ids, adgroup_ids, ad_ids).", "in": "query", "name": "filtering", "required": false, "schema": { "type": "string" } }, { "description": "Meta date_preset (e.g. last_7d, last_30d, this_month). Mutually exclusive with fromDate/toDate.", "in": "query", "name": "datePreset", "required": false, "schema": { "type": "string" } }, { "description": "Start of range (YYYY-MM-DD); requires toDate. Required on TikTok.", "in": "query", "name": "fromDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "End of range (YYYY-MM-DD); requires fromDate.", "in": "query", "name": "toDate", "required": false, "schema": { "format": "date", "type": "string" } }, { "description": "Days per row (1-90), monthly, or all_days.", "in": "query", "name": "timeIncrement", "required": false, "schema": { "type": "string" } }, { "description": "Rows per page", "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 500, "minimum": 1, "type": "integer" } }, { "description": "Cursor from paging.after of the previous page.", "in": "query", "name": "after", "required": false, "schema": { "type": "string" } } ], "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" } } } } ``` ## 费用与请求规则 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 公开参考值不是你的账户报价或最终扣费。对于支持 X-AISA-Cost-Mode: quote 的接口，执行前请针对完整请求获取免费报价；执行后通过响应费用元数据和 Usage Logs 核对结算费用。1 USD 等于 1,000,000 个整数 micro-USD。 ## OpenAPI ````yaml reference-contracts/zh/aisa-ads.json GET /apis/v1/ads/insights openapi: 3.1.0 info: description: '' title: AIsa Ads version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: [] x-aisa-document: facts_hash: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 generator_version: '3' protocol_version: '1' schema_version: '1' composer_version: '27' response_pending: [] document_hash: sha256:ba353f59e89e1ebabe0e301d8ef57d3cbfa6bb406a8c591ee9c3833d64b60520 x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: aisa-ads x-aisa-catalogs: aisa-ads: title: AIsa Ads description: '' x-aisa-document: facts_hash: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09 generator_version: '3' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/ads/insights: get: summary: Flexible live insights query description: >- Ad Insights. Read only. Runs a custom performance query against Meta, Google Ads or TikTok and returns the platform's rows as is, for reports the fixed endpoints don't cover. The account's platform picks the contract. ### Meta (facebook/instagram) Forwards caller-chosen `fields`, `breakdowns` and `filtering` to any Meta insights node and returns Meta's rows verbatim. `objectId` (required) selects the node. 当前未提供请求参考价格；请使用接口支持的报价功能确认费用。 最终费用以账户适用价格及实际结算为准。 operationId: get_aisa_ads_apis_v1_ads_insights 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 (required there): 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. in: query name: objectId required: false schema: type: string - description: 'Google only (required there): the GAQL SELECT statement to run.' in: query name: query required: false schema: maxLength: 10000 type: string - description: >- Google: platform ad account ID (Google customer ID, digits only) when the connection has several Google Ads accounts. TikTok (required there): the advertiser id. in: query name: adAccountId required: false schema: type: string - description: 'TikTok only: report_type.' in: query name: reportType required: false schema: default: BASIC enum: - BASIC - AUDIENCE type: string - description: 'TikTok only (required there): data_level.' in: query name: dataLevel required: false schema: enum: - AUCTION_ADVERTISER - AUCTION_CAMPAIGN - AUCTION_ADGROUP - AUCTION_AD type: string - description: >- TikTok only (required there): 1-4 comma-separated TikTok dimensions (e.g. country_code, campaign_id, stat_time_day). in: query name: dimensions required: false schema: type: string - description: >- TikTok only (required there): comma-separated TikTok metrics (e.g. reach,impressions,frequency,spend). in: query name: metrics required: false schema: type: string - description: 'TikTok only: page number.' in: query name: page required: false schema: default: 1 minimum: 1 type: integer - description: 'TikTok only: rows per page.' in: query name: pageSize required: false schema: default: 100 maximum: 1000 minimum: 1 type: integer - description: Alias of adAccountId, kept for existing callers in: query name: customerId required: false schema: type: string - description: 'Google only: cursor from paging.nextPageToken of the previous page.' in: query name: pageToken required: false schema: type: string - description: Row granularity in: query name: level required: false schema: enum: - ad - adset - campaign - account type: string - description: >- Comma-separated Graph insights fields (e.g. spend,impressions,frequency,website_purchase_roas). Omitted = Meta's default set. in: query name: fields required: false schema: type: string - description: >- Meta only: comma-separated Graph breakdowns (e.g. age,gender or publisher_platform). Returns 400 on TikTok (add the breakdown to dimensions with reportType=AUDIENCE, e.g. in: query name: breakdowns required: false schema: type: string - description: >- Comma-separated Graph action breakdowns; segments the actions[] arrays in each row. in: query name: actionBreakdowns required: false schema: type: string - description: >- Comma-separated Meta attribution windows. Action values are returned keyed per window. in: query name: actionAttributionWindows required: false schema: type: string - description: 'When actions are counted: impression, conversion or mixed.' in: query name: actionReportTime required: false schema: type: string - description: Use the ad sets' own attribution settings for action counting. in: query name: useUnifiedAttributionSetting required: false schema: type: boolean - description: >- JSON array of filter objects: [{"field", "operator", "value"}]. Applied server-side by Meta or TikTok (TikTok fields e.g. campaign_ids, adgroup_ids, ad_ids). in: query name: filtering required: false schema: type: string - description: >- Meta date_preset (e.g. last_7d, last_30d, this_month). Mutually exclusive with fromDate/toDate. in: query name: datePreset required: false schema: type: string - description: Start of range (YYYY-MM-DD); requires toDate. Required on TikTok. in: query name: fromDate required: false schema: format: date type: string - description: End of range (YYYY-MM-DD); requires fromDate. in: query name: toDate required: false schema: format: date type: string - description: Days per row (1-90), monthly, or all_days. in: query name: timeIncrement required: false schema: type: string - description: Rows per page in: query name: limit required: false schema: default: 25 maximum: 500 minimum: 1 type: integer - description: Cursor from paging.after of the previous page. in: query name: after required: false schema: type: string responses: '200': content: application/json: schema: properties: adAccountId: description: 'TikTok responses only: the advertiser queried.' type: string customerId: description: 'Google responses only: the customer the query ran against.' type: string data: items: description: >- Raw platform row. Meta: keys are the requested Graph fields plus date_start/date_stop. Google: nested GAQL resources in camelCase, int64 counters as strings. TikTok: { dimensions, metrics } with metric values as strings. type: object type: array fieldMask: description: >- Google responses only: the selected fields echoed by Google. type: - string - 'null' objectId: description: Meta responses only. type: string paging: properties: after: description: Meta cursor for the next page; null when exhausted. type: - string - 'null' nextPageToken: description: Google cursor for the next page; null when exhausted. type: - string - 'null' page: description: 'TikTok only: current page.' type: integer pageSize: description: TikTok only. type: integer totalPages: description: TikTok only. type: integer totalRows: description: TikTok only. type: integer type: object type: object description: Insight rows (raw platform shape) default: content: application/json: schema: properties: error: properties: code: type: - string - 'null' details: additionalProperties: {} type: - object - 'null' message: type: - string - 'null' param: type: - string - 'null' retryHint: type: - string - 'null' retryable: type: - boolean - 'null' type: type: - string - 'null' type: - object - 'null' type: object description: Error. The code field is stable; see the error catalog. components: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.