# Récupérer les données de cohorte

> Récupère les données de cohorte pour suivre des groupes d'utilisateurs dans le temps.
>
> Les revenus de cet endpoint sont basés sur la **cohorte par date d'installation** : les revenus de chaque utilisateur sont attribués à leur **date d'installation**, et non à la date de la transaction. La réponse expose `total_revenue_usd` et `total_proceeds_usd`. Utilisez cet endpoint (plutôt que l'endpoint d'analyse) pour réconcilier les rapports internes avec Ads Manager, qui est également basé sur les cohortes/dates d'installation.
>
> Limite de débit : 2 requêtes par seconde.

## OpenAPI

```yaml
/api-specs/export-analytics-api.yaml post /api/v1/client-api/metrics/cohort/
openapi: 3.1.0
info:
  title: API Adapty Export Analytics
  version: 1.0.0
  description: |
    L'API Adapty Export Analytics vous permet d'exporter vos données d'analyse au format CSV ou JSON,
    vous offrant la flexibilité d'approfondir les métriques de performance de votre application, de personnaliser les rapports
    et d'analyser les tendances au fil du temps. Grâce à cette API, vous pouvez facilement extraire des données d'analyse détaillées,
    ce qui facilite le suivi, le partage et l'affinement de vos informations de données selon vos besoins.
servers:
  - url: https://api-admin.adapty.io
    description: Serveur de production
security:
  - apikeyAuth: []
paths:
  /api/v1/client-api/metrics/cohort/:
    post:
      summary: Récupérer les données de cohorte
      description: |-
        Récupère les données de cohorte pour suivre des groupes d'utilisateurs dans le temps.

        Les revenus de cet endpoint sont basés sur la **cohorte par date d'installation** : les revenus de chaque utilisateur sont attribués à leur **date d'installation**, et non à la date de la transaction. La réponse expose `total_revenue_usd` et `total_proceeds_usd`. Utilisez cet endpoint (plutôt que l'endpoint d'analyse) pour réconcilier les rapports internes avec Ads Manager, qui est également basé sur les cohortes/dates d'installation.

        Limite de débit : 2 requêtes par seconde.
      operationId: retrieveCohortData
      security:
        - apikeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CohortDataRequest"
            examples:
              basic:
                summary: Requête de données de cohorte de base
                value:
                  filters:
                    date:
                      - "2024-04-01"
                      - "2024-09-30"
                    store:
                      - app_store
                    country:
                      - us
                  period_unit: month
                  period_type: renewals
                  value_type: absolute
                  value_field: subscriptions
      responses:
        "200":
          description: Données de cohorte récupérées avec succès
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CohortDataResponse"
              example:
                data:
                  - segment_start_date: "2024-04-01"
                    type: total
                    title: Total
                    total_installs: 0
                    total_subscriptions: 0
                    total_paid_subscribers: 0
                    total_revenue_usd: 0
                    total_proceeds_usd: 0
                    total_net_revenue_usd: 0
                    total_anrpas_usd: 0
                    total_appas_usd: 0
                    total_arpas_usd: 0
                    total_anrppu_usd: 0
                    total_apppu_usd: 0
                    total_arppu_usd: 0
                    total_anrpu_usd: 0
                    total_appu_usd: 0
                    total_arpu_usd: 0
                    predict: null
                    values:
                      - arpas_usd: 0
                        appas_usd: 0
                        anrpas_usd: 0
                        anrppu_usd: 0
                        apppu_usd: 0
                        arppu_usd: 0
                        anrpu_usd: 0
                        appu_usd: 0
                        arpu_usd: 0
                        installs: 0
                        period: 1
                        revenue_usd: 0
                        proceeds_usd: 0
                        net_revenue_usd: 0
                        revenue_relative: 0
                        proceeds_relative: 0
                        net_revenue_relative: 0
                        subscriptions: 0
                        subscriptions_relative: 0
                        subscribers: 0
                        subscribers_relative: 0
                        currently_active_period: false
            text/csv:
              schema:
                type: string
                description: Données de cohorte au format CSV
        "400":
          description: Requête incorrecte
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Non autorisé
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UnauthorizedError"
        "429":
          description: Limite de débit dépassée. Maximum 2 requêtes par seconde par clé API.
components:
  schemas:
    CohortDataRequest:
      type: object
      required:
        - filters
      properties:
        filters:
          $ref: "#/components/schemas/MetricsFilters"
        period_unit:
          type: string
          enum:
            - day
            - week
            - month
            - quarter
            - year
          description: Indiquez l'intervalle de temps pour l'agrégation des données d'analyse
          default: month
        period_type:
          type: string
          enum:
            - renewals
            - days
          description: Analysez les données par renouvellements ou par jours
          default: renewals
        value_type:
          type: string
          enum:
            - absolute
            - relative
          description: Indiquez comment les valeurs sont affichées
          default: absolute
        value_field:
          type: string
          enum:
            - revenue
            - arppu
            - arpu
            - arpas
            - subscribers
            - subscriptions
          description: Indiquez le type de valeurs affichées
          default: revenue
        accounting_type:
          type: string
          enum:
            - revenue
            - proceeds
            - net_revenue
          description: La méthode comptable utilisée
          default: revenue
        renewal_days:
          type: array
          items:
            type: integer
          description: Liste des jours depuis l'installation de l'application pour le type de cohorte period_type=days
        prediction_months:
          type: integer
          enum:
            - 3
            - 6
            - 9
            - 12
            - 18
            - 24
          description: Indiquez le nombre de mois de prédiction souhaité
          default: 12
        format:
          type: string
          enum:
            - json
            - csv
          description: Indiquez le format de fichier d'export
          default: json
    CohortDataResponse:
      type: object
      description: Réponse contenant les données d'analyse de cohorte montrant le comportement des utilisateurs dans le temps
      properties:
        data:
          type: array
          description: Tableau de segments de cohorte, chacun représentant un groupe d'utilisateurs ayant démarré durant la même période
          items:
            $ref: "#/components/schemas/CohortSegment"
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              errors:
                type: array
                items:
                  type: string
        error_code:
          type: string
        status_code:
          type: integer
    UnauthorizedError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              errors:
                type: array
                items:
                  type: string
        error_code:
          type: string
        status_code:
          type: integer
    MetricsFilters:
      type: object
      required:
        - date
      properties:
        date:
          type: array
          items:
            type: string
          description: Entrez la date ou la période pour laquelle vous souhaitez récupérer les données du graphique
        compare_date:
          type: array
          items:
            type: string
          description: Entrez la date ou la période de comparaison
        store:
          type: array
          items:
            type: string
          description: Filtrez par le store où l'achat a été effectué
        country:
          type: array
          items:
            type: string
          description: Filtrez par le code pays à 2 lettres où l'achat a eu lieu
        store_product_id:
          type: array
          items:
            type: string
          description: Identifiant unique d'un produit dans le store
        duration:
          type: array
          items:
            type: string
          description: Indiquez la durée de l'abonnement
        attribution_source:
          type: array
          items:
            type: string
          description: L'intégration source pour l'attribution
        attribution_status:
          type: array
          items:
            type: string
          description: Indique si l'attribution est organique ou non organique
        attribution_channel:
          type: array
          items:
            type: string
          description: Canal marketing ayant conduit à la transaction
        attribution_campaign:
          type: array
          items:
            type: string
          description: Campagne marketing ayant apporté la transaction
        attribution_adgroup:
          type: array
          items:
            type: string
          description: Groupe d'annonces d'attribution ayant apporté la transaction
        attribution_adset:
          type: array
          items:
            type: string
          description: Ensemble d'annonces d'attribution ayant conduit à la transaction
        attribution_creative:
          type: array
          items:
            type: string
          description: Éléments visuels ou textuels spécifiques d'une annonce ou d'une campagne, suivis pour mesurer leur efficacité
        offer_category:
          type: array
          items:
            type: string
          description: Indiquez les catégories d'offres pour lesquelles vous souhaitez récupérer des données
        offer_type:
          type: array
          items:
            type: string
          description: Indiquez les types d'offres pour lesquels vous souhaitez récupérer des données
        offer_id:
          type: array
          items:
            type: string
          description: Indiquez les offres spécifiques pour lesquelles vous souhaitez récupérer des données
    CohortSegment:
      type: object
      description: Un segment de cohorte représentant les utilisateurs ayant démarré durant la même période
      properties:
        segment_start_date:
          type: string
          description: La date de début de ce segment de cohorte
        type:
          type: string
          description: Type de segment ('total' pour les données agrégées, 'single' pour une cohorte individuelle)
        title:
          type: string
          description: Titre d'affichage pour ce segment de cohorte
        total_installs:
          type: integer
          description: Nombre total d'installations de l'application dans cette cohorte
        total_subscriptions:
          type: integer
          description: Nombre total d'abonnements dans cette cohorte
        total_paid_subscribers:
          type: integer
          description: Nombre total d'abonnés payants dans cette cohorte
        total_revenue_usd:
          type: number
          description: Revenu total en USD pour cette cohorte
        total_proceeds_usd:
          type: number
          description: Produits nets totaux en USD pour cette cohorte (après frais du store)
        total_net_revenue_usd:
          type: number
          description: Revenu net total en USD pour cette cohorte
        total_anrpas_usd:
          type: number
          description: Revenu net moyen par abonné actif (ANRPAS) total en USD
        total_appas_usd:
          type: number
          description: Produits nets moyens par abonné actif (APPAS) totaux en USD
        total_arpas_usd:
          type: number
          description: Revenu moyen par abonné actif (ARPAS) total en USD
        total_anrppu_usd:
          type: number
          description: Revenu net moyen par utilisateur payant (ANRPPU) total en USD
        total_apppu_usd:
          type: number
          description: Produits nets moyens par utilisateur payant (APPPU) totaux en USD
        total_arppu_usd:
          type: number
          description: Revenu moyen par utilisateur payant (ARPPU) total en USD
        total_anrpu_usd:
          type: number
          description: Revenu net moyen par utilisateur (ANRPU) total en USD
        total_appu_usd:
          type: number
          description: Produits nets moyens par utilisateur (APPU) totaux en USD
        total_arpu_usd:
          type: number
          description: Revenu moyen par utilisateur (ARPU) total en USD
        predict:
          type: object
          nullable: true
          description: Données de prédiction pour cette cohorte (si disponibles)
        values:
          type: array
          description: Tableau de valeurs par période montrant les performances de la cohorte dans le temps
          items:
            $ref: "#/components/schemas/CohortValue"
    CohortValue:
      type: object
      description: Valeur de période individuelle au sein d'un segment de cohorte affichant les métriques de performance pour une période donnée
      properties:
        arpas_usd:
          type: number
          description: Revenu moyen par abonné actif en USD pour cette période
        appas_usd:
          type: number
          description: Produits nets moyens par abonné actif en USD pour cette période
        anrpas_usd:
          type: number
          description: Revenu net moyen par abonné actif en USD pour cette période
        anrppu_usd:
          type: number
          description: Revenu net moyen par utilisateur payant en USD pour cette période
        apppu_usd:
          type: number
          description: Produits nets moyens par utilisateur payant en USD pour cette période
        arppu_usd:
          type: number
          description: Revenu moyen par utilisateur payant en USD pour cette période
        anrpu_usd:
          type: number
          description: Revenu net moyen par utilisateur en USD pour cette période
        appu_usd:
          type: number
          description: Produits nets moyens par utilisateur en USD pour cette période
        arpu_usd:
          type: number
          description: Revenu moyen par utilisateur en USD pour cette période
        installs:
          type: integer
          description: Nombre d'installations de l'application durant cette période
        period:
          type: integer
          description: Numéro de période (1 = première période, 2 = deuxième période, etc.)
        revenue_usd:
          type: number
          description: Revenu total en USD pour cette période
        proceeds_usd:
          type: number
          description: Produits nets totaux en USD pour cette période (après frais du store)
        net_revenue_usd:
          type: number
          description: Revenu net total en USD pour cette période
        revenue_relative:
          type: number
          description: Revenu en pourcentage par rapport à la première période (100% = première période)
        proceeds_relative:
          type: number
          description: Produits nets en pourcentage par rapport à la première période (100% = première période)
        net_revenue_relative:
          type: number
          description: Revenu net en pourcentage par rapport à la première période (100% = première période)
        subscriptions:
          type: integer
          description: Nombre d'abonnements durant cette période
        subscriptions_relative:
          type: number
          description: Abonnements en pourcentage par rapport à la première période (100% = première période)
        subscribers:
          type: integer
          description: Nombre d'abonnés durant cette période
        subscribers_relative:
          type: number
          description: Abonnés en pourcentage par rapport à la première période (100% = première période)
        currently_active_period:
          type: boolean
          description: Indique si cette période est la période actuellement active pour la cohorte
  securitySchemes:
    apikeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Vous devez authentifier vos requêtes API avec votre clé API secrète en tant qu'en-tête Authorization.
        Vous pouvez la trouver dans les paramètres de l'application. Le format est `Api-Key {VOTRE_CLÉ_API_SECRÈTE}`,
        par exemple : `Api-Key secret_live_...`.
```