POST /api/v1/client-api/metrics/ltv/

Recuperar datos de Valor de Vida del Cliente (LTV)

Copy as Markdown

Recupera datos de LTV para evaluar el potencial de ingresos a largo plazo de los clientes durante su período de engagement.

Límite de tasa: 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

Identificador único de un producto del 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 rastreados para medir la 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 analíticas

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

period_typestring

Analiza los datos por renovaciones o por días

One of: "renewals", "days"

segmentationstring

Define la base para la segmentación

formatstring

Especifica el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos de LTV recuperados correctamente

Schema

Respuesta que contiene datos de Valor de Vida del Cliente (LTV) para diferentes tipos de ingresos

revenueobject

LTV calculado usando ingresos brutos

dataarray of object

Array de puntos de datos de LTV para diferentes cohortes

titlestring

Título de visualización para este punto de datos de LTV

typestring

Tipo de dato de LTV ('total' para datos agregados)

valuenumber

Valor de LTV para esta cohorte

valuesarray of object

Array de valores de LTV por período

cohort_sizeinteger

Número de usuarios en esta cohorte

descriptionstring

Descripción en HTML que explica cómo se calcula el LTV

valuenumber

El valor general de LTV

unitstring

Unidad de medida (normalmente 'USD')

titlestring

Título de visualización para esta métrica de LTV

proceedsobject

LTV calculado usando ingresos netos (tras las comisiones del store)

dataarray of object

Array de puntos de datos de LTV para diferentes cohortes

titlestring

Título de visualización para este punto de datos de LTV

typestring

Tipo de dato de LTV ('total' para datos agregados)

valuenumber

Valor de LTV para esta cohorte

valuesarray of object

Array de valores de LTV por período

cohort_sizeinteger

Número de usuarios en esta cohorte

descriptionstring

Descripción en HTML que explica cómo se calcula el LTV

valuenumber

El valor general de LTV

unitstring

Unidad de medida (normalmente 'USD')

titlestring

Título de visualización para esta métrica de LTV

net_revenueobject

LTV calculado usando ingresos netos

dataarray of object

Array de puntos de datos de LTV para diferentes cohortes

titlestring

Título de visualización para este punto de datos de LTV

typestring

Tipo de dato de LTV ('total' para datos agregados)

valuenumber

Valor de LTV para esta cohorte

valuesarray of object

Array de valores de LTV por período

cohort_sizeinteger

Número de usuarios en esta cohorte

descriptionstring

Descripción en HTML que explica cómo se calcula el LTV

valuenumber

El valor general de LTV

unitstring

Unidad de medida (normalmente 'USD')

titlestring

Título de visualización para esta métrica de LTV

Example 
{
  "revenue": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  },
  "proceeds": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  },
  "net_revenue": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  }
}

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 tasa superado. Máximo 2 solicitudes por segundo por clave de API.