Retrieve Lifetime Value (LTV) data

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

Endpoint and method

POST https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/

Request example

cURL

curl --location 'https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/' \
--header 'Authorization: Api-Key <YOUR_SECRET_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": {
    "date": [
      "2024-01-01",
      "2024-12-31"
    ],
    "compare_date": [
      "2023-01-01",
      "2023-12-31"
    ],
    "offer_category": [
      "introductory"
    ],
    "store": [
      "app_store"
    ],
    "country": [
      "us"
    ],
    "attribution_source": [
      "appsflyer"
    ],
    "attribution_status": [
      "organic"
    ],
    "attribution_channel": [
      "social_media"
    ]
  },
  "period_unit": "quarter",
  "period_type": "renewals",
  "segmentation": "store_product_id",
  "format": "csv"
}'

Python

import requests
import json

url = "https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/"

payload = json.dumps({
"filters": {
  "date": [
    "2024-01-01",
    "2024-12-31"
  ],
  "compare_date": [
    "2023-01-01",
    "2023-12-31"
  ],
  "offer_category": [
    "introductory"
  ],
  "store": [
    "app_store"
  ],
  "country": [
    "us"
  ],
  "attribution_source": [
    "appsflyer"
  ]
},
"period_unit": "quarter",
"period_type": "renewals",
"segmentation": "store_product_id",
"format": "csv"
})
headers = {
'Authorization':"Api-Key <YOUR_SECRET_API_KEY>",
'Content-Type': "application/json"
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JavaScript

const myHeaders = new Headers();
myHeaders.append("Authorization", "Api-Key <YOUR_SECRET_API_KEY>");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
"filters": {
  "date": [
    "2024-01-01",
    "2024-12-31"
  ],
  "compare_date": [
    "2023-01-01",
    "2023-12-31"
  ],
  "offer_category": [
    "introductory"
  ],
  "store": [
    "app_store"
  ],
  "country": [
    "us"
  ],
  "attribution_source": [
    "appsflyer"
  ]
},
"period_unit": "quarter",
"period_type": "renewals",
"segmentation": "store_product_id",
"format": "csv"
});

const requestOptions = {
method: "POST",
headers: myHeaders,
body: raw,
redirect: "follow"
};

fetch("https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));

Parameters

Name	Type	Required	Description
filters	MetricsFilters	➕	An object containing filtration parameters. See details below this table.
period_unit	String	➖	Specify the time interval for aggregating analytics data, to view results grouped by selected periods, such as days, weeks, months, etc. Possible values are: day week month quarter year
period_type	String	➖	Possible values are: renewals days
segmentation	String	➖	Possible values are: day week month year country product paywall paywalls_group audience placement duration store
format	String	➖	Specify the export file format. Available options are: json csv

MetricsFilters object

Name	Type	Required	Description
date	array of String values(data)	➕	Enter the date or period for which you want to retrieve chart data.
compare_date	array of String values(data)	➖	If comparing two dates or periods, enter the earlier one here and the later one in the date parameter.
store	array of String values	➖	Filter by the app store where the purchase was made. Possible values include app_store, play_store, stripe, and any custom store ID. If using a custom store, enter its ID as set in the Adapty Dashboard.
country	array of String values	➖	Filter by the 2-letter country code where the purchase took place, using ISO 3166-1 standard codes.
store_product_id	array of String values	➖	Unique identifier of a product from the app store. You can see this ID in the Products section of the Adapty Dashboard.
duration	array of String	➖	Specify the subscription duration. Possible values are: Weekly Monthly 2 months 3 months 6 months Annual Lifetime Uncategorized
attribution_source	array of String values	➖	The source integration for attribution. Possible options: adjust airbridge apple_search_ads appsflyer branch custom
attribution_status	array of String values	➖	Indicates if the attribution is organic or non-organic. Possible values are: organic non-organic unknown
attribution_channel	array of String values	➖	Marketing channel that led to the transaction.
attribution_campaign	array of String values	➖	Marketing campaign that brought the transaction.
attribution_adgroup	array of String values	➖	Attribution ad group that brought the transaction.
attribution_adset	array of String values	➖	Attribution ad set that led to the transaction.
attribution_creative	array of String values	➖	Specific visual or text elements in an ad or campaign tracked to measure effectiveness (e.g., clicks, conversions).
offer_category	array of String values	➖	Specify the offer categories you want to retrieve data for. Possible values are: introductory promotional winback
offer_type	array of String values	➖	Specify the offer types you want to retrieve data for. Possible values are: free_trial pay_as_you_go pay_up_front
offer_id	array of String values	➖	Specify the specific offers you want to retrieve data for.