POST /api/v1/client-api/metrics/retention/

Recuperar datos de retención

Copy as Markdown

Recupera los datos de retención para analizar la capacidad de un producto de mantener a los usuarios comprometidos a lo largo del tiempo.

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"

segmentationstring

Define la base para la segmentación

use_trialboolean

Valor booleano que indica si se utilizó un periodo de prueba

formatstring

Especifica el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos de retención recuperados correctamente

Schema

Respuesta que contiene datos de retención que muestran el engagement de los usuarios a lo largo del tiempo

dataarray of object

Array de puntos de datos de retención (puede estar vacío para algunos tipos de retención)

titlestring

Título de visualización para la métrica de retención

metric_namestring

Nombre interno de la métrica de retención

descriptionstring

Explicación de cómo se calcula la retención (valores absolutos frente a relativos)

value_typestring

Tipo de valor de retención (absoluto o relativo)

Example 
{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": null
}

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.