> ## Documentation Index > Fetch the complete documentation index at: https://chatbotx.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get ad analytics overview > Returns merged ads analytics (funnel plus channel spend/ROAS/CPM) for one ad, channel, account, and date range. Requires a connected ads account; use `ads.getFunnel` for a DB-only funnel without spend data. ## OpenAPI ````yaml /api-reference/platform-api.json get /v1/ads/analytics/overview openapi: 3.1.1 info: title: ChatbotX version: 0.0.1 servers: - url: https://app.chatbotx.io/api security: - bearerAuth: [] - developerAccessToken: [] - tokenInSearchParams: [] paths: /v1/ads/analytics/overview: get: tags: - Ads summary: Get ad analytics overview description: >- Returns merged ads analytics (funnel plus channel spend/ROAS/CPM) for one ad, channel, account, and date range. Requires a connected ads account; use `ads.getFunnel` for a DB-only funnel without spend data. operationId: ads.getAnalyticsOverview parameters: - name: from in: query required: true schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Start date (YYYY-MM-DD, inclusive). allowEmptyValue: true allowReserved: true - name: to in: query required: true schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: End date (YYYY-MM-DD, inclusive). allowEmptyValue: true allowReserved: true - name: tz in: query required: false schema: type: string description: IANA timezone used to bucket results. allowEmptyValue: true allowReserved: true - name: adAccountId in: query required: false schema: type: string pattern: ^act_\d+$ description: >- Restrict to this Meta ad account id (act_). Get it from `ads.listChannelAdAccounts`. allowEmptyValue: true allowReserved: true - name: channel in: query required: false schema: enum: - whatsapp - messenger - instagram type: string description: Restrict to this channel. allowEmptyValue: true allowReserved: true - name: integrationWhatsappId in: query required: false schema: type: string pattern: ^\d+$ description: Restrict to this WhatsApp integration. allowEmptyValue: true allowReserved: true - name: integrationMessengerId in: query required: false schema: type: string pattern: ^\d+$ description: Restrict to this Messenger integration. allowEmptyValue: true allowReserved: true - name: integrationInstagramId in: query required: false schema: type: string pattern: ^\d+$ description: Restrict to this Instagram integration. allowEmptyValue: true allowReserved: true - name: allChannels in: query required: false schema: type: boolean description: >- Aggregate across every channel instead of one. Mutually exclusive with channel/integration filters. allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: totals: type: object properties: conversations: type: number leads: type: number purchases: type: number revenue: type: number spend: type: number costPerLead: anyOf: - type: number - type: 'null' costPerPurchase: anyOf: - type: number - type: 'null' roas: anyOf: - type: number - type: 'null' impressions: type: number clicks: type: number cpc: anyOf: - type: number - type: 'null' ctr: anyOf: - type: number - type: 'null' cpm: anyOf: - type: number - type: 'null' costPerConversation: anyOf: - type: number - type: 'null' required: - conversations - leads - purchases - revenue - spend - costPerLead - costPerPurchase - roas - impressions - clicks - cpc - ctr - cpm - costPerConversation perAd: type: array items: type: object properties: adId: anyOf: - type: string - type: 'null' adName: anyOf: - type: string - type: 'null' conversations: type: number leads: type: number purchases: type: number revenue: type: number channels: type: array items: type: string spend: anyOf: - type: number - type: 'null' costPerLead: anyOf: - type: number - type: 'null' costPerPurchase: anyOf: - type: number - type: 'null' roas: anyOf: - type: number - type: 'null' impressions: anyOf: - type: number - type: 'null' clicks: anyOf: - type: number - type: 'null' cpc: anyOf: - type: number - type: 'null' ctr: anyOf: - type: number - type: 'null' cpm: anyOf: - type: number - type: 'null' costPerConversation: anyOf: - type: number - type: 'null' required: - adId - conversations - leads - purchases - revenue - spend - costPerLead - costPerPurchase - roas - impressions - clicks - cpc - ctr - cpm - costPerConversation spendCurrency: anyOf: - type: string - type: 'null' required: - totals - perAd - spendCurrency '400': description: '400' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: businessError status: const: 400 message: type: string default: An error occurred while processing your request data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '401': description: '401' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: UNAUTHORIZED status: const: 401 message: type: string default: Authentication required data: {} required: - defined - code - status - message - type: object properties: defined: const: true code: const: INVALID_CHATBOT_TOKEN status: const: 401 message: type: string default: Invalid or missing workspace API token data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '403': description: '403' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: FORBIDDEN status: const: 403 message: type: string default: You do not have permission to perform this action data: {} required: - defined - code - status - message - type: object properties: defined: const: true code: const: trialExpired status: const: 403 message: type: string default: Trial expired data: {} required: - defined - code - status - message - type: object properties: defined: const: true code: const: macLimitReached status: const: 403 message: type: string default: Monthly active contact limit reached data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '422': description: '422' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: invalidRequestData status: const: 422 message: type: string default: Input validation failed data: type: object properties: issues: type: array items: type: object properties: message: type: string path: type: array items: anyOf: - type: string - type: number - type: object properties: key: anyOf: - type: string - type: number required: - key additionalProperties: {} required: - message additionalProperties: {} required: - issues additionalProperties: {} required: - defined - code - status - message - data - type: object properties: defined: const: true code: const: validation status: const: 422 message: type: string default: Validation error data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '429': description: '429' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: tooManyRequests status: const: 429 message: type: string default: Too many requests data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '500': description: '500' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: INTERNAL_SERVER_ERROR status: const: 500 message: type: string default: An unexpected error occurred data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' components: schemas: UndefinedError: type: object properties: defined: const: false code: type: string status: type: number message: type: string data: {} required: - defined - code - status - message securitySchemes: bearerAuth: type: http scheme: bearer developerAccessToken: type: http scheme: bearer tokenInSearchParams: type: apiKey in: query name: token ````