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

# Récupérer les analyses des commandes de l'établissement



## OpenAPI

````yaml /fr/api-reference/analytics-v1.json get /v1/locations/{location_id}/analytics/orders
openapi: 3.0.0
info:
  title: API Analytics Chataigne
  description: Récupérez les analyses des établissements et des organisations Chataigne.
  version: '2026-05-01'
  contact: {}
servers:
  - url: https://server.chataigne.ai
security: []
tags: []
paths:
  /v1/locations/{location_id}/analytics/orders:
    get:
      tags:
        - Analyses
      summary: Récupérer les analyses des commandes de l'établissement
      operationId: AnalyticsV1Controller_retrieveLocationOrders
      parameters:
        - name: location_id
          in: path
          required: true
          schema:
            type: string
          example: loc_r8v4n2c6tz
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Début de la période d'analyse. Si `from` et `to` sont omis, la
            période couvre par défaut les 30 derniers jours.
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Fin de la période d'analyse. Si `from` et `to` sont omis, la période
            se termine par défaut à l'instant présent.
        - name: service_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - delivery
              - collection
          description: >-
            Limite les statistiques liées aux commandes aux livraisons ou aux
            retraits.
      responses:
        '200':
          description: Les analyses des commandes de l'établissement.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationOrderAnalytics'
        '400':
          description: Requête invalide.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentification requise.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            L'identité authentifiée n'est pas autorisée à effectuer cette
            requête.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: La ressource n'existe pas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - organization-api-key: []
components:
  schemas:
    LocationOrderAnalytics:
      type: object
      required:
        - object
        - location_id
        - period
        - summary
        - daily
        - average_by_weekday
        - average_by_hour
      properties:
        object:
          type: string
          enum:
            - location_order_analytics
        location_id:
          type: string
          example: loc_r8v4n2c6tz
        period:
          $ref: '#/components/schemas/AnalyticsPeriod'
        summary:
          type: object
          required:
            - order_count
            - failed_order_count
          properties:
            order_count:
              type: integer
              example: 320
              description: Commandes confirmées ou en cours passées via Chataigne.
            failed_order_count:
              type: integer
              example: 6
              description: Commandes annulées ou refusées pendant la période.
        daily:
          type: array
          items:
            $ref: '#/components/schemas/AnalyticsDailyOrderCount'
        average_by_weekday:
          type: array
          items:
            type: object
            required:
              - weekday
              - average_order_count
            properties:
              weekday:
                type: string
                enum:
                  - monday
                  - tuesday
                  - wednesday
                  - thursday
                  - friday
                  - saturday
                  - sunday
                example: monday
              average_order_count:
                type: number
                example: 12.5
        average_by_hour:
          type: array
          items:
            type: object
            required:
              - hour
              - average_order_count
            properties:
              hour:
                type: integer
                minimum: 0
                maximum: 23
                example: 12
              average_order_count:
                type: number
                example: 1.4
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - authorization_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - idempotency_error
                - api_error
            code:
              type: string
              example: resource_missing
            message:
              type: string
            param:
              type: string
            request_id:
              type: string
              example: req_8f2c…
            details:
              type: object
              additionalProperties: true
    AnalyticsPeriod:
      type: object
      required:
        - from
        - to
        - service_type
      properties:
        from:
          type: string
          format: date-time
          nullable: true
        to:
          type: string
          format: date-time
          nullable: true
        service_type:
          type: string
          enum:
            - delivery
            - collection
          nullable: true
    AnalyticsDailyOrderCount:
      type: object
      required:
        - date
        - order_count
      properties:
        date:
          type: string
          format: date
          example: '2026-06-01'
        order_count:
          type: integer
          example: 12
  securitySchemes:
    organization-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Clé API d’établissement ou d’organisation.

````