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

Retrieve Lifetime Value (LTV) data

Copy as Markdown

Retrieves LTV data to assess the long-term revenue potential of customers over their engagement period.

Rate limit: 2 requests per second.

Request body

filtersobjectrequired
datearray of stringrequired

Enter the date or time period for which you want to retrieve chart data

compare_datearray of string

Enter the comparison date or time period

storearray of string

Filter by the app store where the purchase was made

countryarray of string

Filter by the 2-letter country code where the purchase took place

store_product_idarray of string

Unique identifier of a product from the app store

durationarray of string

Specify the subscription duration

attribution_sourcearray of string

The source integration for attribution

attribution_statusarray of string

Indicates if the attribution is organic or non-organic

attribution_channelarray of string

Marketing channel that led to the transaction

attribution_campaignarray of string

Marketing campaign that brought the transaction

attribution_adgrouparray of string

Attribution ad group that brought the transaction

attribution_adsetarray of string

Attribution ad set that led to the transaction

attribution_creativearray of string

Specific visual or text elements in an ad or campaign tracked to measure effectiveness

offer_categoryarray of string

Specify the offer categories you want to retrieve data for

offer_typearray of string

Specify the offer types you want to retrieve data for

offer_idarray of string

Specify the specific offers you want to retrieve data for

period_unitstring

Specify the time interval for aggregating analytics data

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

period_typestring

Analyze data by renewals or by days

One of: "renewals", "days"

segmentationstring

Sets the basis for segmentation

formatstring

Specify the export file format

One of: "json", "csv"

Responses

LTV data retrieved successfully

Schema

Response containing Lifetime Value (LTV) data for different revenue types

revenueobject

LTV calculated using gross revenue

dataarray of object

Array of LTV data points for different cohorts

titlestring

Display title for this LTV data point

typestring

Type of LTV data ('total' for aggregated data)

valuenumber

LTV value for this cohort

valuesarray of object

Array of period-based LTV values

cohort_sizeinteger

Number of users in this cohort

descriptionstring

HTML description explaining how LTV is calculated

valuenumber

The overall LTV value

unitstring

Unit of measurement (typically 'USD')

titlestring

Display title for this LTV metric

proceedsobject

LTV calculated using proceeds (after store fees)

dataarray of object

Array of LTV data points for different cohorts

titlestring

Display title for this LTV data point

typestring

Type of LTV data ('total' for aggregated data)

valuenumber

LTV value for this cohort

valuesarray of object

Array of period-based LTV values

cohort_sizeinteger

Number of users in this cohort

descriptionstring

HTML description explaining how LTV is calculated

valuenumber

The overall LTV value

unitstring

Unit of measurement (typically 'USD')

titlestring

Display title for this LTV metric

net_revenueobject

LTV calculated using net revenue

dataarray of object

Array of LTV data points for different cohorts

titlestring

Display title for this LTV data point

typestring

Type of LTV data ('total' for aggregated data)

valuenumber

LTV value for this cohort

valuesarray of object

Array of period-based LTV values

cohort_sizeinteger

Number of users in this cohort

descriptionstring

HTML description explaining how LTV is calculated

valuenumber

The overall LTV value

unitstring

Unit of measurement (typically 'USD')

titlestring

Display title for this LTV metric

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

Bad Request

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Unauthorized

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Rate limit exceeded. Maximum 2 requests per second per API key.