> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve analytics chart data

> Runs the chart query for the given `chart_type` and returns `content.stats`. Row shape varies by chart; `business_name` appears on `top_customers` rows only.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /analytics/charts
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /analytics/charts:
    parameters: []
    get:
      tags:
        - Analytics
      summary: Retrieve analytics chart data
      description: >-
        Runs the chart query for the given `chart_type` and returns
        `content.stats`. Row shape varies by chart; `business_name` appears on
        `top_customers` rows only.
      operationId: get-analytics-charts
      parameters:
        - name: chart_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - event_stats
              - visitor_stats
              - page_view_stats
              - top_customers
              - associated_campaigns
              - ce_item_stats
              - overall_shipping_performance
              - average_time_between_subsequent_purchases
              - product_checkout_funnel
              - checkout_funnel
        - name: date_from
          in: query
          required: true
          schema:
            type: string
            format: date-time
        - name: date_to
          in: query
          required: true
          schema:
            type: string
            format: date-time
        - name: interval
          in: query
          required: true
          schema:
            type: string
            enum:
              - hour
              - day
              - week
              - month
        - name: preset
          in: query
          required: false
          schema:
            type: string
        - name: query_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - metrics
              - stats
        - name: seller_id
          in: query
          required: false
          schema:
            type: string
        - name: timezone
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      user_params:
                        type: object
                        additionalProperties: true
                      query_params:
                        type: object
                        additionalProperties: true
                      queries:
                        type: array
                        items:
                          type: string
                      stats:
                        type: array
                        items:
                          type: object
                          additionalProperties: true
                          properties:
                            business_name:
                              description: >-
                                Returned when `chart_type` is `top_customers`.
                                Coalesced billing or customer business name.
                              oneOf:
                                - type: string
                                - type: 'null'
                    required:
                      - stats
                    type: object
components:
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.