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

# Get store metrics summary

> Retrieve aggregated store metrics including counts, revenue, and MRR. When startDate and endDate are provided, totals are filtered to that date range. When interval is also provided, the response includes a periods array with time-series data points grouped by that interval. The periods array starts from the store's first transaction or startDate, whichever is later, to avoid empty leading buckets. All monetary amounts are in cents (integer, no decimals).



## OpenAPI

````yaml get /v1/stats/summary
openapi: 3.0.0
info:
  title: Creem API
  description: >-
    Creem is an all-in-one platform for managing subscriptions and recurring
    revenue, tailored specifically for today's SaaS companies. It enables you to
    boost revenue, enhance customer retention, and scale your operations
    seamlessly.
  version: v1
  contact:
    name: Creem Support
    url: https://creem.io
    email: support@creem.io
  license:
    name: Commercial
    url: https://creem.io/terms
  termsOfService: https://creem.io/terms
servers:
  - url: https://api.creem.io
    description: Production — live API for processing real transactions and data.
    x-speakeasy-server-id: prod
  - url: https://test-api.creem.io
    description: Test — sandbox API for development and testing with no real charges.
    x-speakeasy-server-id: test
security: []
tags: []
externalDocs:
  description: Creem Documentation
  url: https://docs.creem.io
paths:
  /v1/stats/summary:
    get:
      tags:
        - Stats
      summary: Get store metrics summary
      description: >-
        Retrieve aggregated store metrics including counts, revenue, and MRR.
        When startDate and endDate are provided, totals are filtered to that
        date range. When interval is also provided, the response includes a
        periods array with time-series data points grouped by that interval. The
        periods array starts from the store's first transaction or startDate,
        whichever is later, to avoid empty leading buckets. All monetary amounts
        are in cents (integer, no decimals).
      operationId: getMetricsSummary
      parameters:
        - name: startDate
          required: false
          in: query
          description: >-
            Start of the date range as a Unix timestamp in milliseconds (e.g.
            1740614400000). When provided with endDate, filters totals to this
            range. Required when interval is specified.
          schema:
            type: number
        - name: endDate
          required: false
          in: query
          description: >-
            End of the date range as a Unix timestamp in milliseconds (e.g.
            1772150400000). When provided with startDate, filters totals to this
            range. Required when interval is specified.
          schema:
            type: number
        - name: interval
          required: false
          in: query
          description: >-
            Groups time-series data into buckets of this size. Requires
            startDate and endDate. Returns a periods array with one entry per
            bucket containing grossRevenue and netRevenue.
          schema:
            enum:
              - day
              - week
              - month
            type: string
        - name: currency
          required: true
          in: query
          schema:
            enum:
              - EUR
              - USD
            type: string
      responses:
        '200':
          description: Successfully retrieved store metrics summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsSummaryEntity'
        '400':
          description: Bad Request - Invalid input parameters
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Not Found - Resource does not exist
      security:
        - ApiKey: []
components:
  schemas:
    StatsSummaryEntity:
      type: object
      properties:
        totals:
          description: Aggregated totals for the queried date range
          allOf:
            - $ref: '#/components/schemas/StatsMetricTotalsEntity'
        periods:
          description: >-
            Time-series data points grouped by the requested interval. Only
            present when interval, startDate, and endDate are provided.
          example:
            - timestamp: 1763337600000
              grossRevenue: 2999
              netRevenue: 2909
            - timestamp: 1763942400000
              grossRevenue: 32989
              netRevenue: 31998
            - timestamp: 1764547200000
              grossRevenue: 47984
              netRevenue: 46542
            - timestamp: 1765152000000
              grossRevenue: 125958
              netRevenue: 122173
            - timestamp: 1765756800000
              grossRevenue: 343968
              netRevenue: 278372
            - timestamp: 1766361600000
              grossRevenue: 0
              netRevenue: 0
            - timestamp: 1766966400000
              grossRevenue: 0
              netRevenue: 0
            - timestamp: 1767571200000
              grossRevenue: 225240
              netRevenue: 192096
          type: array
          items:
            $ref: '#/components/schemas/StatsMetricPeriodEntity'
      required:
        - totals
    StatsMetricTotalsEntity:
      type: object
      properties:
        totalProducts:
          type: number
          description: Total number of products in the store
          example: 12
        totalSubscriptions:
          type: number
          description: Total number of subscriptions within the queried date range
          example: 48
        totalCustomers:
          type: number
          description: Total number of customers within the queried date range
          example: 35
        totalPayments:
          type: number
          description: Total number of payments within the queried date range
          example: 62
        activeSubscriptions:
          type: number
          description: Number of currently active subscriptions
          example: 21
        totalRevenue:
          type: number
          description: Total gross revenue in cents within the queried date range
          example: 553939
        totalNetRevenue:
          type: number
          description: >-
            Total net revenue in cents within the queried date range (after fees
            and taxes)
          example: 478094
        netMonthlyRecurringRevenue:
          type: number
          description: Net monthly recurring revenue in cents (after estimated fees)
          example: 89500
        monthlyRecurringRevenue:
          type: number
          description: Gross monthly recurring revenue in cents
          example: 94200
      required:
        - totalProducts
        - totalSubscriptions
        - totalCustomers
        - totalPayments
        - activeSubscriptions
        - totalRevenue
        - totalNetRevenue
        - netMonthlyRecurringRevenue
        - monthlyRecurringRevenue
    StatsMetricPeriodEntity:
      type: object
      properties:
        timestamp:
          type: number
          description: >-
            Start of the period as a Unix timestamp in milliseconds (e.g. Monday
            of that week for weekly intervals)
          example: 1765152000000
        grossRevenue:
          type: number
          description: Gross revenue in cents for this period
          example: 125958
        netRevenue:
          type: number
          description: Net revenue in cents for this period (after fees and taxes)
          example: 122173
      required:
        - timestamp
        - grossRevenue
        - netRevenue
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can find your API key in the Creem
        dashboard under Settings > API Keys.

````