POST /api/v1/client-api/metrics/cohort/

Recuperar datos de cohorte

Recupera datos de cohorte para realizar un seguimiento de grupos de usuarios a lo largo del tiempo.

Los ingresos de este endpoint se basan en cohortes por fecha de instalación: los ingresos de cada usuario se atribuyen a su fecha de instalación, no a la fecha de la transacción. La respuesta expone total_revenue_usd y total_proceeds_usd. Usa este endpoint (en lugar del endpoint de analíticas) para conciliar informes internos con Ads Manager, que también se basa en cohortes/fechas de instalación.

Límite de velocidad: 2 solicitudes por segundo.

Request body

filtersobjectrequired

datearray of stringrequired

Introduce la fecha o el período de tiempo para el que deseas recuperar los datos del gráfico

compare_datearray of string

Introduce la fecha o el período de tiempo de comparación

storearray of string

Filtra por el store donde se realizó la compra

countryarray of string

Filtra por el código de país de 2 letras donde se realizó la compra

store_product_idarray of string

ID de producto cualificado por store, con el formato <store>:<product_id> — por ejemplo app_store:premium_monthly o play_store:premium_sub:monthly-base-plan para una suscripción de Google con un plan base. Se rechaza un ID de producto sin prefijo de store.

durationarray of string

Especifica la duración de la suscripción

attribution_sourcearray of string

La integración de origen para la atribución

attribution_statusarray of string

Indica si la atribución es orgánica o no orgánica

attribution_channelarray of string

Canal de marketing que originó la transacción

attribution_campaignarray of string

Campaña de marketing que originó la transacción

attribution_adgrouparray of string

Grupo de anuncios de atribución que originó la transacción

attribution_adsetarray of string

Conjunto de anuncios de atribución que originó la transacción

attribution_creativearray of string

Elementos visuales o de texto específicos de un anuncio o campaña cuyo seguimiento se realiza para medir su efectividad

offer_categoryarray of string

Especifica las categorías de oferta para las que deseas recuperar datos

offer_typearray of string

Especifica los tipos de oferta para los que deseas recuperar datos

offer_idarray of string

Especifica las ofertas concretas para las que deseas recuperar datos

period_unitstring

Especifica el intervalo de tiempo para agregar los datos de análisis

One of: "day", "week", "month", "quarter", "year"

period_typestring

Analiza los datos por renovaciones o por días

One of: "renewals", "days"

value_typestring

Especifica cómo se muestran los valores

One of: "absolute", "relative"

value_fieldstring

Especifica el tipo de valores que se muestran

One of: "revenue", "arppu", "arpu", "arpas", "subscribers", "subscriptions"

accounting_typestring

El método contable utilizado

One of: "revenue", "proceeds", "net_revenue"

renewal_daysarray of integer

Lista de días transcurridos desde la instalación de la aplicación para el tipo de cohorte period_type=days

prediction_monthsinteger

Indica cuántos meses de predicción deseas obtener

One of: 3, 6, 9, 12, 18, 24

formatstring

Especifica el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos de cohorte recuperados correctamente

Schema

Respuesta que contiene datos de análisis de cohorte que muestran el comportamiento de los usuarios a lo largo del tiempo

dataarray of object

Array de segmentos de cohorte, cada uno representa un grupo de usuarios que comenzaron en el mismo período

segment_start_datestring

La fecha de inicio de este segmento de cohorte

typestring

Tipo de segmento ('total' para datos agregados, 'single' para cohorte individual)

titlestring

Título de visualización para este segmento de cohorte

total_installsinteger

Número total de instalaciones de la app en esta cohorte

total_subscriptionsinteger

Número total de suscripciones en esta cohorte

total_paid_subscribersinteger

Número total de suscriptores de pago en esta cohorte

total_revenue_usdnumber

Ingresos totales en USD para esta cohorte

total_proceeds_usdnumber

Ingresos netos totales en USD para esta cohorte (después de las comisiones del store)

total_net_revenue_usdnumber

Ingresos netos totales en USD para esta cohorte

total_anrpas_usdnumber

Ingresos medios totales por suscriptor activo (ANRPAS) en USD

total_appas_usdnumber

Ingresos netos medios totales por suscriptor activo (APPAS) en USD

total_arpas_usdnumber

Ingresos medios totales por suscriptor activo (ARPAS) en USD

total_anrppu_usdnumber

Ingresos medios totales por usuario de pago (ANRPPU) en USD

total_apppu_usdnumber

Ingresos netos medios totales por usuario de pago (APPPU) en USD

total_arppu_usdnumber

Ingresos medios totales por usuario de pago (ARPPU) en USD

total_anrpu_usdnumber

Ingresos medios totales por usuario (ANRPU) en USD

total_appu_usdnumber

Ingresos netos medios totales por usuario (APPU) en USD

total_arpu_usdnumber

Ingresos medios totales por usuario (ARPU) en USD

predictobject

Datos de predicción para esta cohorte (si están disponibles)

valuesarray of object

Array de valores basados en períodos que muestran el rendimiento de la cohorte a lo largo del tiempo

arpas_usdnumber

Ingresos medios por suscriptor activo en USD para este período

appas_usdnumber

Ingresos netos medios por suscriptor activo en USD para este período

anrpas_usdnumber

Ingresos netos medios por suscriptor activo en USD para este período

anrppu_usdnumber

Ingresos netos medios por usuario de pago en USD para este período

apppu_usdnumber

Ingresos netos medios por usuario de pago en USD para este período

arppu_usdnumber

Ingresos medios por usuario de pago en USD para este período

anrpu_usdnumber

Ingresos netos medios por usuario en USD para este período

appu_usdnumber

Ingresos netos medios por usuario en USD para este período

arpu_usdnumber

Ingresos medios por usuario en USD para este período

installsinteger

Número de instalaciones de la aplicación en este período

periodinteger

Número de período (1 = primer período, 2 = segundo período, etc.)

revenue_usdnumber

Ingresos totales en USD para este período

proceeds_usdnumber

Ingresos netos totales en USD para este período (después de las comisiones del store)

net_revenue_usdnumber

Ingresos netos totales en USD para este período

revenue_relativenumber

Ingresos como porcentaje relativo al primer período (100% = primer período)

proceeds_relativenumber

Ingresos netos como porcentaje relativo al primer período (100% = primer período)

net_revenue_relativenumber

Ingresos netos como porcentaje relativo al primer período (100% = primer período)

subscriptionsinteger

Número de suscripciones en este período

subscriptions_relativenumber

Suscripciones como porcentaje relativo al primer período (100% = primer período)

subscribersinteger

Número de suscriptores en este período

subscribers_relativenumber

Suscriptores como porcentaje relativo al primer período (100% = primer período)

currently_active_periodboolean

Indica si este es el período actualmente activo para la cohorte

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
        }
      ]
    }
  ]
}

Solicitud incorrecta

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

No autorizado

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Límite de velocidad superado. Máximo 2 solicitudes por segundo por clave de API.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "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"
    })
data = response.json()