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

# Account analytics summary (with optional point-in-time as-of review)

> Returns the account's buying-analytics summary: RFM (recency / frequency /
monetary + segment), account health score + band + trend, TTM revenue, average
order value, and the revenue trend percentage.

Default (no `as_of`): the stored denormalized analytics columns (refreshed nightly
+ incrementally on order events).

Point-in-time review (`?as_of=YYYY-MM-DD`): re-anchors the trailing windows
(recency, the 12-month TTM, and the 3-month revenue/frequency trend) to the
supplied historical date and recomputes RFM / health / TTM / revenue-trend IN
MEMORY. This is a READ-ONLY review -- it NEVER persists, never updates the account,
never emits events. Useful for migrated accounts whose latest order predates today,
so you can see each customer's standing "as of" the data's latest point instead of
an arbitrary later wall-clock now. Industry precedent: NetSuite SuiteAnalytics
"As-Of Date", Salesforce/HubSpot snapshot-date reports, QuickBooks/Xero "as of date".

The review response is the same shape as the default plus `as_of` (the echoed date)
and `is_review: true`.




## OpenAPI

````yaml /openapi.yaml get /accounts/{id}/analytics/summary
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /accounts/{id}/analytics/summary:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Account UUID or account_number slug.
    get:
      tags:
        - Accounts
      summary: Account analytics summary (with optional point-in-time as-of review)
      description: >
        Returns the account's buying-analytics summary: RFM (recency / frequency
        /

        monetary + segment), account health score + band + trend, TTM revenue,
        average

        order value, and the revenue trend percentage.


        Default (no `as_of`): the stored denormalized analytics columns
        (refreshed nightly

        + incrementally on order events).


        Point-in-time review (`?as_of=YYYY-MM-DD`): re-anchors the trailing
        windows

        (recency, the 12-month TTM, and the 3-month revenue/frequency trend) to
        the

        supplied historical date and recomputes RFM / health / TTM /
        revenue-trend IN

        MEMORY. This is a READ-ONLY review -- it NEVER persists, never updates
        the account,

        never emits events. Useful for migrated accounts whose latest order
        predates today,

        so you can see each customer's standing "as of" the data's latest point
        instead of

        an arbitrary later wall-clock now. Industry precedent: NetSuite
        SuiteAnalytics

        "As-Of Date", Salesforce/HubSpot snapshot-date reports, QuickBooks/Xero
        "as of date".


        The review response is the same shape as the default plus `as_of` (the
        echoed date)

        and `is_review: true`.
      operationId: getAccountAnalyticsSummary
      parameters:
        - name: as_of
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >
            Optional point-in-time review anchor (YYYY-MM-DD). Must be a real
            calendar date

            and `<= today`. A malformed or future date returns 400
            `invalid_as_of_date`.
      responses:
        '200':
          description: Account analytics summary (review path adds `as_of` + `is_review`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ttm_revenue:
                        type: number
                      avg_order_value:
                        type: number
                      rfm_recency:
                        type: integer
                      rfm_frequency:
                        type: integer
                      rfm_monetary:
                        type: integer
                      rfm_score:
                        type: string
                      rfm_segment:
                        type: string
                      account_health_score:
                        type: integer
                      account_health_band:
                        type: string
                      account_health_trend:
                        type: string
                      revenue_trend_pct:
                        type: number
                      days_since_last_order:
                        type: integer
                      as_of:
                        type: string
                        format: date
                        nullable: true
                        description: Present (echoed) only on the as-of review path.
                      is_review:
                        type: boolean
                        description: True only on the as-of review path.
        '400':
          description: Invalid or future `as_of` date (`invalid_as_of_date`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - accounts:read
components:
  schemas:
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````