Retrieve conversion data

Retrieves conversion data to analyze user actions and measure the effectiveness of marketing efforts over time.

Endpoint and method

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

Request example

cURL

curl --location 'https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/' \
--header 'Authorization: Api-Key <YOUR_SECRET_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": {
    "date": [
      "2024-01-01",
      "2024-12-31"
    ]
  },
  "from_period": 1,
  "to_period": "6+",
  "period_unit": "month",
  "date_type": "purchase_date",
  "segmentation": "country",
  "format": "csv"
}'

Python

import requests
import json

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

payload = json.dumps({
"filters": {
  "date": [
    "2024-01-01",
    "2024-12-31"
  ]
},
"from_period": 1,
"to_period": "6+",
"period_unit": "month",
"date_type": "purchase_date",
"segmentation": "country",
"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"
  ]
},
"from_period": 1,
"to_period": "6+",
"period_unit": "month",
"date_type": "purchase_date",
"segmentation": "country",
"format": "csv"
});

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

fetch("https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/", 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.
from_period	String/null	➕	The user’s starting subscription state of the conversation (e.g., null = install, 0 = trial, 1 = first paid period, etc.). See Conversion types for valid values.
to_period	String	➕	The user’s new subscription state after the conversion (e.g., 0 = trial, 1 = first paid period, 6+ = after six months, etc.). See Conversion types for valid values.
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 (default) quarter year
date_type	String	➖	Specify which date should be treated as a user joining date. Possible values: purchase_date (default) profile_install_date
segmentation	String	➖	Sets the basis for segmentation. Possible values are: app_id period renewal_status cancellation_reason store_product_id country store purchase_container_id paywall_id audience_id placement_id attribution_source attribution_status attribution_channel attribution_campaign attribution_adgroup attribution_adset attribution_creative duration default
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.

Conversion types

Use from_period and to_period together to specify the exact conversion you want to analyze. Only transitions supported by the Adapty Dashboard are available:

Conversation	from_period	to_period
Install → Trial The user has just installed the app (no subscription yet) and started a free trial.	null	0
Install → Paid The user has just installed the app and jumped straight to a paid subscription.	null	1
Trial → Paid The user switched from a free trial to a paid subscription.	0	1
Paid → 2nd period The user renewed from the first paid period to the second.	1	2
2nd → 3rd period The user renewed from the second paid period to the third.	2	3
3rd → 4th period The user renewed from the third paid period to the fourth.	3	4
4th → 5th period The user renewed from the fourth paid period to the fifth.	4	5
Paid → 6 months+ The user stayed on a paid subscription for six months or longer.	1	"6+"
Paid → 1 year+ The user stayed on a paid subscription for a year or longer.	1	"12+"
Paid → 2 years+ The user stayed on a paid subscription for two years or longer.	1	"24+"